vg::Version Class Reference

Class for holding vg version and build environment information. More...

#include <version.hpp>

Static Public Member Functions
static string	get_version ()
	Get only the version (like v1.7.0-68-g224e7625). More...
static string	get_release ()
static string	get_codename ()
	Get the codename of our released version. More...
static string	get_short ()
	Get a short one-line description of the current version of vg with no terminating newline. More...
static string	get_long ()

Static Public Attributes
const static string	VERSION = VG_GIT_VERSION
	The Git version description of this build of vg. More...
const static string	COMPILER = VG_COMPILER_VERSION
	The compiler used to build vg. More...
const static string	STANDARD_LIBRARY = VG_STANDARD_LIBRARY_VERSION
const static string	HTSLIB_HEADERS = VG_HTSLIB_VERSION
const static string	HTSLIB_LIBRARY
const static string	OS = VG_OS
	The OS that vg was built on. More...
const static string	BUILD_USER = VG_BUILD_USER
	The user who built vg. More...
const static string	BUILD_HOST = VG_BUILD_HOST
	The host that built vg. More...

Private Member Functions
	Version ()=delete

Static Private Attributes
const static unordered_map< string, string >	codenames
	Store all the codenames by major version. More...

Detailed Description

Class for holding vg version and build environment information.

Constructor & Destructor Documentation

Version()

vg::Version::Version ( )

privatedelete

Member Function Documentation

get_codename()

string vg::Version::get_codename ( )

static

Get the codename of our released version.

get_long()

string vg::Version::get_long ( )

static

Get a long, potentially multi-line description of the current version of vg with no terminating newline.

get_release()

string vg::Version::get_release ( )

static

Get the release Git tag version of vg that the current version is based on (e.g. v1.7.0-68-g224e7625 will report v1.7.0).

get_short()

string vg::Version::get_short ( )

static

Get a short one-line description of the current version of vg with no terminating newline.

get_version()

string vg::Version::get_version ( )

static

Get only the version (like v1.7.0-68-g224e7625).

Member Data Documentation

BUILD_HOST

const string vg::Version::BUILD_HOST = VG_BUILD_HOST

static

The host that built vg.

BUILD_USER

const string vg::Version::BUILD_USER = VG_BUILD_USER

static

The user who built vg.

codenames

const unordered_map< string, string > vg::Version::codenames

staticprivate

Store all the codenames by major version.

COMPILER

const string vg::Version::COMPILER = VG_COMPILER_VERSION

static

The compiler used to build vg.

HTSLIB_HEADERS

const string vg::Version::HTSLIB_HEADERS = VG_HTSLIB_VERSION

static

HTSLIB_LIBRARY

const string vg::Version::HTSLIB_LIBRARY

static

OS

const string vg::Version::OS = VG_OS

static

The OS that vg was built on.

STANDARD_LIBRARY

const string vg::Version::STANDARD_LIBRARY = VG_STANDARD_LIBRARY_VERSION

static

VERSION

const string vg::Version::VERSION = VG_GIT_VERSION

static

The Git version description of this build of vg.

---

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

• src/version.hpp
• src/version.cpp