Peptide::VersionFormat< VersionTrait > Class Template Reference

Utility class for formatting version information. More...

#include <VerFormat.h>

Static Public Member Functions
static std::string	getVersionID ()
	Returns a short version identifier for the given version trait. More...
static std::string	getVersionInfo ()
	Returns detailed information for the given version trait. More...

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

Detailed Description

template<class VersionTrait>
class Peptide::VersionFormat< VersionTrait >

Utility class for formatting version information.

The VersionTrait is typically generated using CMake configuration files. It contains all of the version information of given component (library, executable, etc.). This class contains functions to format this version information to a human readable form.

The VersionTrait must provide the following static member functions: static int getMajorVersion(); static int getMinorVersion(); static int getPatchLevel(); static char const* getGitCommit(); static char const* getGitBranch(); static int getBuildNumber(); static char const* getBuildDate(); static char const* getProductName();

Template Parameters

VersionTrait

CMake generated version trait.

Definition at line 66 of file VerFormat.h.

Constructor & Destructor Documentation

VersionFormat()

template<class VersionTrait >

Peptide::VersionFormat< VersionTrait >::VersionFormat ( )

privatedelete

Prohibited and not implemented.

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

Member Function Documentation

getVersionID()

template<class VersionTrait >

static std::string Peptide::VersionFormat< VersionTrait >::getVersionID ( )

inlinestatic

Returns a short version identifier for the given version trait.

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

Definition at line 86 of file VerFormat.h.

Referenced by Peptide::VersionFormat< VersionTrait >::getVersionInfo().

Here is the caller graph for this function:

getVersionInfo()

template<class VersionTrait >

static std::string Peptide::VersionFormat< VersionTrait >::getVersionInfo ( )

inlinestatic

Returns detailed information for the given version trait.

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

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

Note that only the short git hash is included. Note that the product version may have four fields if PEPTIDE uses PEPTIDE_ARCH_VERSION.

Definition at line 106 of file VerFormat.h.

References Peptide::VersionFormat< VersionTrait >::getVersionID(), and Ufe::PathString::string().

Here is the call graph for this function:

---

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

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