version.h File Reference

Describe the genvtx API version. More...

#include <string>

Go to the source code of this file.

Classes
struct	genvtx::version
	Describe the genvtx API version and features. More...

Namespaces
	genvtx
	Top-level namespace of the Bayeux/genvtx module library.

Macros
#define	GENVTX_VERSION_MAJOR   5
	Major version number of genvtx. More...
#define	GENVTX_VERSION_MINOR   2
	Minor version number of genvtx. More...
#define	GENVTX_VERSION_PATCH   0
	Patch version number of genvtx. More...
#define	GENVTX_ENCODE_VERSION(major, minor, patch)
	Encode genvtx to ordered integer available at compile time. More...
#define	GENVTX_VERSION
	Integer encoded genvtx version available at compile time. More...
#define	GENVTX_LIB_VERSION   "5.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	GENVTX_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the genvtx API version.

Querying the version of genvtx is needed at both compile and runtime by clients so that they may adjust their usage.

Macro Definition Documentation

GENVTX_ENCODE_VERSION

#define GENVTX_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

(     \
                ((major) * 10000) \
                + ((minor) *   100) \
                + ((patch) *     1))

Encode genvtx to ordered integer available at compile time.

GENVTX_IS_AT_LEAST

#define GENVTX_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(       \
                 GENVTX_VERSION >=  \
                 GENVTX_ENCODE_VERSION(major,minor,patch))

Check current version >= (major, minor, patch) at compile time.

GENVTX_LIB_VERSION

#define GENVTX_LIB_VERSION   "5.2.0"

String encoded full version number, e.g. "1.2.3", available at compile time.

GENVTX_VERSION

#define GENVTX_VERSION

Value:

GENVTX_ENCODE_VERSION(        \
               GENVTX_VERSION_MAJOR,  \
               GENVTX_VERSION_MINOR,  \
               GENVTX_VERSION_PATCH)

Integer encoded genvtx version available at compile time.

GENVTX_VERSION_MAJOR

#define GENVTX_VERSION_MAJOR   5

Major version number of genvtx.

GENVTX_VERSION_MINOR

#define GENVTX_VERSION_MINOR   2

Minor version number of genvtx.

GENVTX_VERSION_PATCH

#define GENVTX_VERSION_PATCH   0

Patch version number of genvtx.