CYIVersion is a data structure that represents semantic versioning.
The version information provided by this object is composed of four parts:
When the version is requested as a string, it is returned in the format MAJOR.MINOR.PATCH (or MAJOR.MINOR.PATCH-HOTFIX if the hotfix version is not empty and not 0)
Version objects can also hold an optional version control ID and build date.
#include <framework/YiVersion.h>
Public Member Functions | |
CYIVersion () | |
CYIVersion (uint32_t majorVersion, uint32_t minorVersion, uint32_t patchVersion, CYIString hotfixVersion="", CYIString versionControlID="", CYIString buildDate="") | |
uint32_t | GetMajorVersion () const |
uint32_t | GetMinorVersion () const |
uint32_t | GetPatchVersion () const |
CYIString | GetHotfixVersion () const |
CYIString | GetVersionString () const |
bool | HasHotfixVersion () const |
const CYIString & | GetVersionControlID () const |
const CYIString & | GetBuildDate () const |
bool | operator== (const CYIVersion &other) const |
bool | operator!= (const CYIVersion &other) const |
bool | operator< (const CYIVersion &other) const |
bool | operator> (const CYIVersion &other) const |
bool | operator<= (const CYIVersion &other) const |
bool | operator>= (const CYIVersion &other) const |
Static Public Member Functions | |
static const CYIVersion & | GetEngineVersion () |
static CYIVersion | FromVersionString (const CYIString &versionString) |
CYIVersion::CYIVersion | ( | ) |
Creates a CYIVersion with the major, minor, and patch version set to 0. The hotfix value, version control ID and build date will not be set.
CYIVersion::CYIVersion | ( | uint32_t | majorVersion, |
uint32_t | minorVersion, | ||
uint32_t | patchVersion, | ||
CYIString | hotfixVersion = "" , |
||
CYIString | versionControlID = "" , |
||
CYIString | buildDate = "" |
||
) |
Creates a CYIVersion with majorVersion, minorVersion and patchVersion. A hotfixVersion, versionControlID and buildDate can optionally be provided.
|
static |
const CYIString& CYIVersion::GetBuildDate | ( | ) | const |
Returns a user-readable string that describes the build date. The date is typically formatted as "Mmm dd yyyy hh:mm:ss".
|
static |
Provides version information about this release of You.i Engine SDK.
CYIString CYIVersion::GetHotfixVersion | ( | ) | const |
Returns the hotfix version string.
uint32_t CYIVersion::GetMajorVersion | ( | ) | const |
Returns the major version number.
uint32_t CYIVersion::GetMinorVersion | ( | ) | const |
Returns the minor version number.
uint32_t CYIVersion::GetPatchVersion | ( | ) | const |
Returns the patch version number.
const CYIString& CYIVersion::GetVersionControlID | ( | ) | const |
Returns a version control identifier for this version. For You.i Engine versions, this is a git sha-1.
CYIString CYIVersion::GetVersionString | ( | ) | const |
Returns a version string formatted as MAJOR.MINOR.PATCH, or MAJOR.MINOR.PATCH-HOTFIX if the hotfix version is not blank and not 0.
bool CYIVersion::HasHotfixVersion | ( | ) | const |
Returns whether the CYIVersion object has a hotfix version assigned to it.
bool CYIVersion::operator!= | ( | const CYIVersion & | other | ) | const |
bool CYIVersion::operator< | ( | const CYIVersion & | other | ) | const |
bool CYIVersion::operator<= | ( | const CYIVersion & | other | ) | const |
bool CYIVersion::operator== | ( | const CYIVersion & | other | ) | const |
bool CYIVersion::operator> | ( | const CYIVersion & | other | ) | const |
bool CYIVersion::operator>= | ( | const CYIVersion & | other | ) | const |