libSBML C++ API  5.20.4
libsbml-version.h File Reference

Define libSBML version numbers for access from client software. More...

Include dependency graph for libsbml-version.h:
This graph shows which files directly or indirectly include this file:

Macros

#define LIBSBML_DOTTED_VERSION   "5.20.4"
 LIBSBML_DOTTED_VERSION: More...
 
#define LIBSBML_VERSION   52004
 LIBSBML_VERSION: More...
 
#define LIBSBML_VERSION_STRING   "52004"
 LIBSBML_VERSION_STRING: More...
 

Functions

const char * getLibSBMLDependencyVersionOf (const char *option)
 Returns the version string for the dependency library used. More...
 
const char * getLibSBMLDottedVersion ()
 Returns the version number of this copy of libSBML as a string. More...
 
int getLibSBMLVersion ()
 Returns the version number of this copy of libSBML as an integer. More...
 
const char * getLibSBMLVersionString ()
 Returns the version number of this copy of libSBML as a string without periods. More...
 
int isLibSBMLCompiledWith (const char *option)
 Returns an indication whether libSBML has been compiled with against a specific library. More...
 

Detailed Description

Define libSBML version numbers for access from client software.

Author
Michael Hucka

Macro Definition Documentation

◆ LIBSBML_DOTTED_VERSION

#define LIBSBML_DOTTED_VERSION   "5.20.4"

LIBSBML_DOTTED_VERSION:

A version string of the form "1.2.3".

◆ LIBSBML_VERSION

#define LIBSBML_VERSION   52004

LIBSBML_VERSION:

The version as an integer: version 1.2.3 becomes 10203. Since the major number comes first, the overall number will always increase when a new libSBML is released, making it easy to use less-than and greater-than comparisons when testing versions numbers.

◆ LIBSBML_VERSION_STRING

#define LIBSBML_VERSION_STRING   "52004"

LIBSBML_VERSION_STRING:

The numeric version as a string: version 1.2.3 becomes "10203".

Function Documentation

◆ getLibSBMLDependencyVersionOf()

const char* getLibSBMLDependencyVersionOf ( const char *  option)

Returns the version string for the dependency library used.

Parameters
optionthe library for which the version should be retrieved, this can be one of "expat", "libxml", "xerces-c", "bzip2", "zip"
Returns
NULL in case libSBML has not been compiled against that library and a version string otherwise.
See also
isLibSBMLCompiledWith(const char* option)

◆ getLibSBMLDottedVersion()

const char* getLibSBMLDottedVersion ( )

Returns the version number of this copy of libSBML as a string.

Returns
the libSBML version as a string; version 1.2.3 becomes "1.2.3".
See also
getLibSBMLVersionString()

◆ getLibSBMLVersion()

int getLibSBMLVersion ( )

Returns the version number of this copy of libSBML as an integer.

Returns
the libSBML version as an integer; version 1.2.3 becomes 10203.

◆ getLibSBMLVersionString()

const char* getLibSBMLVersionString ( )

Returns the version number of this copy of libSBML as a string without periods.

Returns
the libSBML version as a string: version 1.2.3 becomes "10203".
See also
getLibSBMLDottedVersion()

◆ isLibSBMLCompiledWith()

int isLibSBMLCompiledWith ( const char *  option)

Returns an indication whether libSBML has been compiled with against a specific library.

Parameters
optionthe library to test against, this can be one of "expat", "libxml", "xerces-c", "bzip2", "zip"
Returns
0 in case the libSBML has not been compiled against that library and nonzero otherwise (for libraries that define an integer version number that number will be returned).
See also
getLibSBMLDependencyVersionOf(const char* option)