Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Access the version information for the API. More...
#include <include/LibVersion.h>
Static Public Member Functions | |
Version Numbers | |
static int | GetMajor () |
Return the major version number, e.g., 1 for "1.2.3". More... | |
static int | GetMinor () |
Return the minor version number, e.g., 2 for "1.2.3". More... | |
static int | GetPatch () |
Return the patch version number, e.g., 3 for "1.2.3". More... | |
static std::string | GetVersion () |
Return the full version number. More... | |
Version Number Maths | |
static bool | IsAtLeast (int major, int minor, int patch) |
Compare the current version number against a specific version. More... | |
Feature Tags | |
static bool | HasFeature (const std::string &name) |
Test whether a feature is implemented by this API. More... | |
Access the version information for the API.
For example, you can get the current version number as a string using GetVersion
, or you can get the separate major, minor and patch integer values by calling GetMajor
, GetMinor
, or GetPatch
, respectively.
This class also provides some basic version comparison functionality and lets you determine if certained named features are present in your current build.
|
static |
Return the major version number, e.g., 1 for "1.2.3".
|
static |
Return the minor version number, e.g., 2 for "1.2.3".
|
static |
Return the patch version number, e.g., 3 for "1.2.3".
|
static |
Return the full version number.
|
static |
Test whether a feature is implemented by this API.
New features that change the implementation of API methods are specified as "feature tags." This method lets you query the API to find out if a given feature is available.
[in] | name | The feature tag name, e.g., "IMAGE_FILE" |
|
static |
Compare the current version number against a specific version.
This method lets you check to see if the current version is greater than or equal to the specified version. This may be useful to perform operations that require a minimum version number.
[in] | major | The major version number to compare against |
[in] | minor | The minor version number to compare against |
[in] | patch | The patch version number to compare against |