Peptide::VersionInfo Class Reference

Information about the version of the product. More...

#include <VerInfo.h>

Public Types
enum class	FileFormatVersionNumbers { kInitial = 100 , kCurrent = kInitial }
	Enum that tracks our file format version numbers. More...

Static Public Member Functions
static std::string	getVersionID ()
	Returns a short version identifier. More...
static std::string	getVersionInfo ()
	Returns detailed information about the version of the product. More...
static std::string	getLibSuffix ()
	Returns the version suffix of the libraries. More...
static int	getFileFormatVersionID ()
	Returns the file version number. More...
static int	getMajorVersion ()
	Returns the components of the product version number. More...
static int	getMinorVersion ()
	Returns the components of the product version number. More...
static int	getPatchLevel ()
	Returns the components of the product version number. More...

Private Member Functions
	VersionInfo ()=delete
	Prohibited and not implemented. More...

Detailed Description

Information about the version of the product.

Definition at line 42 of file VerInfo.h.

Member Enumeration Documentation

FileFormatVersionNumbers

enum class Peptide::VersionInfo::FileFormatVersionNumbers

strong

Enum that tracks our file format version numbers.

Add to the enum and update the kCurrent value as new formats are introduced

Enumerator
kInitial
kCurrent

Definition at line 47 of file VerInfo.h.

Constructor & Destructor Documentation

VersionInfo()

Peptide::VersionInfo::VersionInfo ( )

privatedelete

Prohibited and not implemented.

Don't allow construction since we only have static member functions.

Member Function Documentation

getFileFormatVersionID()

static int Peptide::VersionInfo::getFileFormatVersionID ( )

static

Returns the file version number.

File format version ID is specified by [major][minor]. The minor number is two digits and the major is 1 or 2 digits. For example 100 ( major = 1, minor = 0 )

getLibSuffix()

static std::string Peptide::VersionInfo::getLibSuffix ( )

static

Returns the version suffix of the libraries.

Returns a short version identifier such as for example "4_0".

getMajorVersion()

static int Peptide::VersionInfo::getMajorVersion ( )

static

Returns the components of the product version number.

The version number is of the form "<major>.<minor>.<patch>" or "<arch>.<major>.<minor>.<patch>"

getMinorVersion()

static int Peptide::VersionInfo::getMinorVersion ( )

static

Returns the components of the product version number.

The version number is of the form "<major>.<minor>.<patch>" or "<arch>.<major>.<minor>.<patch>"

getPatchLevel()

static int Peptide::VersionInfo::getPatchLevel ( )

static

Returns the components of the product version number.

The version number is of the form "<major>.<minor>.<patch>" or "<arch>.<major>.<minor>.<patch>"

getVersionID()

static std::string Peptide::VersionInfo::getVersionID ( )

static

Returns a short version identifier.

Returns a short version identifier such as for example "3.0.2".

getVersionInfo()

static std::string Peptide::VersionInfo::getVersionInfo ( )

static

Returns detailed information about the version of the product.

Returns detailed information about the version of the product such as for example:

"MyProduct version 4.0.0 (Mon 09/28/2015, 201509282010, build 34567, commit b5283ef)"

Note that only the short git hash is included.

---

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

• common/include/peptide/versioning/VerInfo.h