version.h File Reference

Describe the datatools API version. More...

#include <string>

Go to the source code of this file.

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

Namespaces
	datatools
	The Bayeux/datatools library top-level namespace.

Macros
#define	DATATOOLS_VERSION_MAJOR   7
	Major version number of datatools. More...
#define	DATATOOLS_VERSION_MINOR   2
	Minor version number of datatools. More...
#define	DATATOOLS_VERSION_PATCH   0
	Patch version number of datatools. More...
#define	DATATOOLS_ENCODE_VERSION(major_, minor_, patch_)
	Encode datatools to ordered integer available at compile time. More...
#define	DATATOOLS_VERSION
	Integer encoded datatools version available at compile time. More...
#define	DATATOOLS_LIB_VERSION   "7.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	DATATOOLS_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the datatools API version.

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

Macro Definition Documentation

DATATOOLS_ENCODE_VERSION

#define DATATOOLS_ENCODE_VERSION	(		major_,
			minor_,
			patch_
	)

Value:

(              \
                                                          ((major_) * 10000) \
                                                          + ((minor_) *   100) \
                                                          + ((patch_) *     1))

Encode datatools to ordered integer available at compile time.

DATATOOLS_IS_AT_LEAST

#define DATATOOLS_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(                      \
                                                  DATATOOLS_VERSION >=  \
                                                  DATATOOLS_ENCODE_VERSION(major,minor,patch))

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

DATATOOLS_LIB_VERSION

#define DATATOOLS_LIB_VERSION   "7.2.0"

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

DATATOOLS_VERSION

#define DATATOOLS_VERSION

Value:

DATATOOLS_ENCODE_VERSION(                     \
                                                   DATATOOLS_VERSION_MAJOR, \
                                                   DATATOOLS_VERSION_MINOR, \
                                                   DATATOOLS_VERSION_PATCH)

Integer encoded datatools version available at compile time.

DATATOOLS_VERSION_MAJOR

#define DATATOOLS_VERSION_MAJOR   7

Major version number of datatools.

DATATOOLS_VERSION_MINOR

#define DATATOOLS_VERSION_MINOR   2

Minor version number of datatools.

DATATOOLS_VERSION_PATCH

#define DATATOOLS_VERSION_PATCH   0

Patch version number of datatools.