gams::GAMSVersion Class Reference

Represents the GAMS version information. More...

#include <gamsversion.h>

Static Public Member Functions

static const char * apiDetail ()
 
static const char * api ()
 
static int apiMajor ()
 
static int apiMinor ()
 
static int apiBuild ()
 
static const char * apiBuildTime ()
 
static const char * gamsVersion ()
 
static int gamsMajor ()
 
static int gamsMinor ()
 
static int gamsBuild ()
 
static std::string systemVersion (std::string gamsSystemDir)
 

Detailed Description

Represents the GAMS version information.

Definition at line 34 of file gamsversion.h.

Member Function Documentation

◆ api()

static const char* gams::GAMSVersion::api ( )
static

Get the API version string, including major and minor version number and build number.

Returns
Returns the API version string.

◆ apiBuild()

static int gams::GAMSVersion::apiBuild ( )
static

Get the API build number.

Returns
The API build number.

◆ apiBuildTime()

static const char* gams::GAMSVersion::apiBuildTime ( )
static

Get the API build time stamp.

Returns
The API build time stamp.

◆ apiDetail()

static const char* gams::GAMSVersion::apiDetail ( )
static

Get the full API version information, including major and minor version number, build number as well as the build time stamp.

Returns
Returns full API information.

◆ apiMajor()

static int gams::GAMSVersion::apiMajor ( )
static

Get the API major version number.

Returns
The API major version number.

◆ apiMinor()

static int gams::GAMSVersion::apiMinor ( )
static

Get the API minor version number.

Returns
The API minor version number.

◆ gamsBuild()

static int gams::GAMSVersion::gamsBuild ( )
static

Get the required GAMS build number.

Returns
Returns the required GAMS build number.

◆ gamsMajor()

static int gams::GAMSVersion::gamsMajor ( )
static

Get the required GAMS major version number.

Returns
Returns the required GAMS major version number.

◆ gamsMinor()

static int gams::GAMSVersion::gamsMinor ( )
static

Get the required GAMS minor version number.

Returns
Returns the required GAMS minor version number.

◆ gamsVersion()

static const char* gams::GAMSVersion::gamsVersion ( )
static

Get the required GAMS version number.

Remarks
This number can be used to check the compatibilty of the API with the GAMS distribution.
Returns
Returns the required GAMS version number.

◆ systemVersion()

static std::string gams::GAMSVersion::systemVersion ( std::string  gamsSystemDir)
static

Get the GAMS version number of an explicit installation path.

Parameters
gamsSystemDirThe GAMS installation path.
Returns
Returns the GAMS version if possible; otherwise an empty string.