optris::VersionInfo Class Reference

Encapsulates version and build information about the SDK. More...

#include <VersionInfo.h>

Collaboration diagram for optris::VersionInfo:

Public Member Functions
	VersionInfo ()=default
	Constructor.
OTC_SDK_API std::string	getVersionString () noexcept
	Returns the SDK version as a string in the format: "major.minor.patch".
OTC_SDK_API int	getMajorVersion () noexcept
	Returns the major version of the SDK.
OTC_SDK_API int	getMinorVersion () noexcept
	Returns the minor version of the SDK.
OTC_SDK_API int	getPatchVersion () noexcept
	Returns the patch version of the SDK.
OTC_SDK_API int	compareVersion (int major, int minor, int patch) noexcept
	Compares the provided version with the one of the SDK.
OTC_SDK_API std::string	getBuildType () noexcept
	Returns the build type of the SDK.
OTC_SDK_API std::string	getBuildDate () noexcept
	Returns the UTC build date of the SDK in ISO format.
OTC_SDK_API std::string	getCommitHash () noexcept
	Returns the first part of the hash of the commit that was used to build the SDK.
OTC_SDK_API std::string	getCommitDate () noexcept
	Returns the date of the commit that was used to build the SDK in ISO format.
OTC_SDK_API std::string	getCommitBranch () noexcept
	Returns the branch name used to build the SDK.
OTC_SDK_API std::string	getName () noexcept
	Returns the name of the SDK.
OTC_SDK_API std::string	getCompany () noexcept
	Returns the name of the company that created the SDK.
OTC_SDK_API std::string	getCopyright () noexcept
	Returns the copyright string of the SDK.
OTC_SDK_API std::string	getDescription () noexcept
	Returns a description of the SDK.
OTC_SDK_API std::string	getBuildOS () noexcept
	Returns the name of the operating system for which the SDK was build for.
OTC_SDK_API std::string	getBuildPlatform () noexcept
	Returns the name of the platform for which the SDK was build for.

Detailed Description

Encapsulates version and build information about the SDK.

The version is represented in the format: major.minor.patch.

Member Function Documentation

compareVersion()

OTC_SDK_API int optris::VersionInfo::compareVersion ( int major, int minor, int patch )

noexcept

Compares the provided version with the one of the SDK.

Returns

0 if both versions are equal. -1 if the SDK version is less than the provided one. +1 if the SDK version is greater than the provide one.

getBuildDate()

OTC_SDK_API std::string optris::VersionInfo::getBuildDate ( )

noexcept

Returns the UTC build date of the SDK in ISO format.

Returns

the UTC build date in ISO format.

getBuildOS()

OTC_SDK_API std::string optris::VersionInfo::getBuildOS ( )

noexcept

Returns the name of the operating system for which the SDK was build for.

Examples: Windows, Linux.

Returns

name of the operating system for which the SDK was build for.

getBuildPlatform()

OTC_SDK_API std::string optris::VersionInfo::getBuildPlatform ( )

noexcept

Returns the name of the platform for which the SDK was build for.

Examples: AMD64, ARM64.

Returns

name of the platform for which the SDK was build for.

getBuildType()

OTC_SDK_API std::string optris::VersionInfo::getBuildType ( )

noexcept

Returns the build type of the SDK.

Returns

"Release" for release builds and "Debug" for debug builds.

getCommitBranch()

OTC_SDK_API std::string optris::VersionInfo::getCommitBranch ( )

noexcept

Returns the branch name used to build the SDK.

Returns

branch name used to build the SDK.

getCommitDate()

OTC_SDK_API std::string optris::VersionInfo::getCommitDate ( )

noexcept

Returns the date of the commit that was used to build the SDK in ISO format.

Returns

date of the commit that was used to build the SDK in ISO format

getCommitHash()

OTC_SDK_API std::string optris::VersionInfo::getCommitHash ( )

noexcept

Returns the first part of the hash of the commit that was used to build the SDK.

Returns

first part of the hash of the commit that was used to build the SDK.

getCompany()

OTC_SDK_API std::string optris::VersionInfo::getCompany ( )

noexcept

Returns the name of the company that created the SDK.

Returns

name of the company that created the SDK.

getCopyright()

OTC_SDK_API std::string optris::VersionInfo::getCopyright ( )

noexcept

Returns the copyright string of the SDK.

Returns

copyright string of the SDK.

getDescription()

OTC_SDK_API std::string optris::VersionInfo::getDescription ( )

noexcept

Returns a description of the SDK.

Returns

description of the SDK.

getMajorVersion()

OTC_SDK_API int optris::VersionInfo::getMajorVersion ( )

noexcept

Returns the major version of the SDK.

Returns

major version of the SDK.

getMinorVersion()

OTC_SDK_API int optris::VersionInfo::getMinorVersion ( )

noexcept

Returns the minor version of the SDK.

Returns

minor version of the SDK.

getName()

OTC_SDK_API std::string optris::VersionInfo::getName ( )

noexcept

Returns the name of the SDK.

Returns

name of the SDK.

getPatchVersion()

OTC_SDK_API int optris::VersionInfo::getPatchVersion ( )

noexcept

Returns the patch version of the SDK.

Returns

patch version of the SDK.

getVersionString()

OTC_SDK_API std::string optris::VersionInfo::getVersionString ( )

noexcept

Returns the SDK version as a string in the format: "major.minor.patch".

Returns

SDK version as string.

---

The documentation for this class was generated from the following file:

• VersionInfo.h