isys::CWinIDEAVersion Class Reference

This class contains a winIDEA version number. More...

#include <CWinIDEAVersion.h>

Public Member Functions
int	compare (const CWinIDEAVersion &other)
	Returns -1 if this version is smaller than other, 0 if equal, and 1 if greater.
	CWinIDEAVersion (const std::string &version)
std::string	get_InstallDir () const
	Returns the installation directory.
uint16_t	getBuild ()
	Returns the winIDEA build number.
uint8_t	getBuildDay ()
	Returns winIDEA build day in range [1..31].
uint8_t	getBuildMonth ()
	Returns winIDEA build month in range [1..12].
uint16_t	getBuildYear ()
	Returns winIDEA build year.
uint8_t	getMajor ()
	Returns the major winIDEA version.
uint8_t	getMinor ()
	Returns the minor winIDEA version.
uint32_t	getSccRevision ()
	Returns the winIDEA source control revision number.
uint16_t	getSubbuild ()
	Returns the winIDEA sub-build number.
std::string	toString () const
	Returns version number as string.

Detailed Description

This class contains a winIDEA version number.

It is not intended to be instantiated by clients; use isys::CIDEController::getWinIDEAVersion() or isys::ConnectionMgr::getWinIDEAVersion() to obtain an instance.

Constructor & Destructor Documentation

CWinIDEAVersion()

isys::CWinIDEAVersion::CWinIDEAVersion

(

const std::string &

version

)

Parameters

version

must be in <major>.<minor>.<build>[.<subbuild>] format, for example: 9.12.209, or 9.12.209.4302

Since

9.12.288

Member Function Documentation

compare()

int isys::CWinIDEAVersion::compare

(

const CWinIDEAVersion &

other

)

Returns -1 if this version is smaller than other, 0 if equal, and 1 if greater.

Since

9.12.288

get_InstallDir()

std::string isys::CWinIDEAVersion::get_InstallDir ( ) const

inline

Returns the installation directory.

Since

9.12.288

getBuild()

uint16_t isys::CWinIDEAVersion::getBuild ( )

inline

Returns the winIDEA build number.

Since

9.12.288

getBuildDay()

uint8_t isys::CWinIDEAVersion::getBuildDay ( )

inline

Returns winIDEA build day in range [1..31].

Returns 0 if build day was not set.

Since

9.17.111

getBuildMonth()

uint8_t isys::CWinIDEAVersion::getBuildMonth ( )

inline

Returns winIDEA build month in range [1..12].

Returns 0 if build month was not set.

Since

9.17.111

getBuildYear()

uint16_t isys::CWinIDEAVersion::getBuildYear ( )

inline

Returns winIDEA build year.

Returns 0 if build year was not set.

Since

9.12.288

getMajor()

uint8_t isys::CWinIDEAVersion::getMajor ( )

inline

Returns the major winIDEA version.

Since

9.12.288

getMinor()

uint8_t isys::CWinIDEAVersion::getMinor ( )

inline

Returns the minor winIDEA version.

Since

9.12.288

getSccRevision()

uint32_t isys::CWinIDEAVersion::getSccRevision ( )

inline

Returns the winIDEA source control revision number.

Returns 0xffff'ffff if this version was not set.

Since

9.12.288

getSubbuild()

uint16_t isys::CWinIDEAVersion::getSubbuild ( )

inline

Returns the winIDEA sub-build number.

Returns 0xffff if sub-build version was not set.

Since

9.12.288

toString()

std::string isys::CWinIDEAVersion::toString

(

)

const

Returns version number as string.

Format: <major>.<minor>.<build>. If sub-build number was also set, the return string is <major>.<minor>.<build>.<sub-build>. Example: 9.10.115

Since

9.12.288