co::Version Class Reference

Information about the current Collage version. More...

#include <version.h>

Collaboration diagram for co::Version:

Static Public Member Functions
static int	getMajor ()
static int	getMinor ()
static int	getPatch ()
static std::string	getString ()
static int	getRevision ()
static int	getABI ()
static std::string	getRevString ()
static bool	check ()
	Runtime check for ABI compatibility. More...
static std::string	getSchema ()
static std::string	toJSON ()

Detailed Description

Information about the current Collage version.

Definition at line 56 of file version.h.

Member Function Documentation

static bool co::Version::check ( )

inlinestatic

Runtime check for ABI compatibility.

Call from code using Collage. Will fail if the executable was compiled against a version incompatible with the runtime version.

Returns

true if the link-time and compile-time DSO are compatible.

Definition at line 88 of file version.h.

References CO_VERSION_MAJOR, and CO_VERSION_MINOR.

static int co::Version::getABI ( )

static

Returns

the current binary interface version of Collage.

Referenced by co::init().

Here is the caller graph for this function:

static int co::Version::getMajor ( )

static

Returns

the current major version of Collage.

static int co::Version::getMinor ( )

static

Returns

the current minor version of Collage.

static int co::Version::getPatch ( )

static

Returns

the current patch level of Collage.

static int co::Version::getRevision ( )

static

Returns

the SCM revision.

static std::string co::Version::getRevString ( )

static

Returns

the current Collage version plus the git SHA hash (MM.mm.pp.rev).

static std::string co::Version::getSchema ( )

inlinestatic

Returns

JSON schema describing this object.

Definition at line 95 of file version.h.

static std::string co::Version::getString ( )

static

Returns

the current Collage version (MM.mm.pp).

static std::string co::Version::toJSON ( )

inlinestatic

Returns

JSON-encoded data for this object.

Definition at line 114 of file version.h.

---

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

• version.h