Version Class Reference

Component information. More...

#include <base/Version.h>

Inherits DynamicObject.

Public Member Functions
virtual unsigned int	getMajorVersion () const noexcept
virtual unsigned int	getMinorVersion () const noexcept
virtual unsigned int	getMicroVersion () const noexcept
virtual unsigned int	getRevision () const noexcept
virtual String	getRelease () const noexcept
virtual String	getVersion () const noexcept
virtual String	getCommit () const noexcept
virtual String	getCommitShort () const noexcept
virtual int64	getBuildDate () const noexcept
virtual String	getBranch () const noexcept
virtual String	getRemoteUrl () const noexcept
virtual String	getBanner () const noexcept
Public Member Functions inherited from DynamicObject
	DynamicObject () noexcept
bool	isValidObject () const noexcept
virtual	~DynamicObject () noexcept(false)
	_COM_AZURE_DEV__BASE__OVERRIDE_ALLOC ()

Static Public Member Functions
static void	printSystem ()
static MemorySize	getDynamicObjectSize () noexcept
static bool	getDefine_COM_AZURE_DEV__BASE__DEBUG () noexcept
static bool	getDefine_DEBUG () noexcept
static bool	isBuildCompatible ()

Detailed Description

Component information.

This class returns information concerning some component (default is this framework).

Version

1.0

Examples

testsuite/Version.cpp.

Member Function Documentation

getBanner()

virtual String Version::getBanner ( ) const

virtualnoexcept

Returns a short banner (multiple lines) describing the framework.

Examples

testsuite/Version.cpp.

getBranch()

virtual String Version::getBranch ( ) const

virtualnoexcept

Returns the source control branch.

getCommit()

virtual String Version::getCommit ( ) const

virtualnoexcept

Returns the full commit id.

getCommitShort()

virtual String Version::getCommitShort ( ) const

virtualnoexcept

Returns the short commit id.

getDefine_COM_AZURE_DEV__BASE__DEBUG()

static bool Version::getDefine_COM_AZURE_DEV__BASE__DEBUG ( )

staticnoexcept

Returns true if _COM_AZURE_DEV__BASE__DEBUG was defined for the Base Framework. _COM_AZURE_DEV__BASE__DEBUG influences class state and must be set identical for dependent projects.

getDefine_DEBUG()

static bool Version::getDefine_DEBUG ( )

staticnoexcept

Returns true if DEBUG, _DEBUG, or _COM_AZURE_DEV__BASE__DEBUG were defined for the Base Framework.

getDynamicObjectSize()

static MemorySize Version::getDynamicObjectSize ( )

staticnoexcept

Returns the size of DynamicObject.

getMajorVersion()

virtual unsigned int Version::getMajorVersion ( ) const

virtualnoexcept

Returns the major version of the framework.

getMicroVersion()

virtual unsigned int Version::getMicroVersion ( ) const

virtualnoexcept

Returns the micro version of the framework.

getMinorVersion()

virtual unsigned int Version::getMinorVersion ( ) const

virtualnoexcept

Returns the minor version of the framework. By convention equal and unequal numbers indicate a final and a debug release, respectively.

getRelease()

virtual String Version::getRelease ( ) const

virtualnoexcept

Returns the release of the framework as a string. The format of the string is unspecified.

getRemoteUrl()

virtual String Version::getRemoteUrl ( ) const

virtualnoexcept

Returns the source control remote url.

getRevision()

virtual unsigned int Version::getRevision ( ) const

virtualnoexcept

Returns the revision of the framework.

getVersion()

virtual String Version::getVersion ( ) const

virtualnoexcept

Returns the version of the framework as a string. The recommended format is 'major.minor.micro suffix' where suffix could be anything.

isBuildCompatible()

static bool Version::isBuildCompatible ( )

inlinestatic

Returns true if the project is built with the correct defines as the Base Framework. Raises exception on conflict.

printSystem()

static void Version::printSystem ( )

static

Print system info.