nlphysics::Version Class Reference

Information about the current nlphysics version. More...

#include <version.h>

Collaboration diagram for nlphysics::Version:

Static Public Member Functions
static int	getMajor ()
static int	getMinor ()
static int	getPatch ()
static std::string	getString ()
static unsigned long long	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 nlphysics version.

Definition at line 64 of file nlphysics/version.h.

Member Function Documentation

static bool nlphysics::Version::check ( )

inlinestatic

Runtime check for ABI compatibility.

Call from code using nlphysics. 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 96 of file nlphysics/version.h.

References NLPHYSICS_VERSION_MAJOR, and NLPHYSICS_VERSION_MINOR.

static int nlphysics::Version::getABI ( )

static

Returns

the current binary interface version of nlphysics.

static int nlphysics::Version::getMajor ( )

static

Returns

the current major version of nlphysics.

static int nlphysics::Version::getMinor ( )

static

Returns

the current minor version of nlphysics.

static int nlphysics::Version::getPatch ( )

static

Returns

the current patch level of nlphysics.

static unsigned long long nlphysics::Version::getRevision ( )

static

Returns

the SCM revision.

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

static

Returns

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

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

inlinestatic

Returns

JSON schema describing this object.

Definition at line 103 of file nlphysics/version.h.

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

static

Returns

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

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

inlinestatic

Returns

JSON-encoded data for this object.

Definition at line 122 of file nlphysics/version.h.

---

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

• nlphysics/version.h