falaise::version Struct Reference

Describe the falaise API version and features. More...

#include <falaise/version.h>

Static Public Member Functions
static int	get_major ()
	Return the major version number of falaise, e.g., 1 for '1.2.3'. More...
static int	get_minor ()
	Return the minor version number of falaise, e.g., 2 for '1.2.3'. More...
static int	get_patch ()
	Return the patch version number of falaise, e.g., 3 for '1.2.3'. More...
static int	get_revision () __attribute__((deprecated))
static std::string	get_commit ()
	Return the first eight characters of the current Git HEAD hash. More...
static bool	is_dirty ()
	Return true when a build from Git used modified, uncommitted changes. More...
static std::string	get_version ()
	Return the full version number of falaise as a string, e.g., '1.2.3'. More...
static bool	is_at_least (int major, int minor, int patch)
	Return true if the current falaise version >= (major, minor, patch) More...
static bool	has_feature (const std::string &feature)
	Return true if the named feature is available in falaise. More...

Detailed Description

Describe the falaise API version and features.

Member Function Documentation

get_commit()

static std::string falaise::version::get_commit ( )

static

Return the first eight characters of the current Git HEAD hash.

get_major()

static int falaise::version::get_major ( )

static

Return the major version number of falaise, e.g., 1 for '1.2.3'.

get_minor()

static int falaise::version::get_minor ( )

static

Return the minor version number of falaise, e.g., 2 for '1.2.3'.

get_patch()

static int falaise::version::get_patch ( )

static

Return the patch version number of falaise, e.g., 3 for '1.2.3'.

get_revision()

static int falaise::version::get_revision ( )

static

Return the current revision number

Deprecated:

since 3.1

See also

get_commit()

get_version()

static std::string falaise::version::get_version ( )

static

Return the full version number of falaise as a string, e.g., '1.2.3'.

has_feature()

static bool falaise::version::has_feature ( const std::string &  feature )

static

Return true if the named feature is available in falaise.

is_at_least()

static bool falaise::version::is_at_least ( int  major, int  minor, int  patch  )

static

Return true if the current falaise version >= (major, minor, patch)

is_dirty()

static bool falaise::version::is_dirty ( )

static

Return true when a build from Git used modified, uncommitted changes.

---

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

• falaise/version.h