HxVersion Class¶

class Hexaly.Optimizer.HxVersion¶: Version, license and copyright info.

Summary¶

Methods¶
`GetMajorVersionNumber`	Returns Hexaly Optimizer major version number.
`GetMinorVersionNumber`	Returns Hexaly Optimizer minor version number.
`GetBuildDate`	Returns Hexaly Optimizer build date.
`GetPlatform`	Returns the platform of the Hexaly Optimizer binary as a string.
`GetVersion`	Returns Hexaly Optimizer version as a string.
`GetVersionCode`	Returns Hexaly Optimizer version code as an integer in the range [0, 29999].
`GetCopyright`	Returns Hexaly Optimizer copyright as a string.
`GetInfo`	Returns version and copyright info as a string.
`GetLicensePath`	Returns the license path of Hexaly Optimizer.
`SetLicensePath`	Change the license path used by Hexaly Optimizer.
`GetLicenseContent`	Returns the license content previously set with HxVersion.SetLicenseContent or the HX_LICENSE_CONTENT environment variable.
`SetLicenseContent`	Change the license content.

Static methods¶

static int GetMajorVersionNumber()¶

Returns Hexaly Optimizer major version number. This number is an integer in the range [0, 2999].

Returns:: Major version number.
Return type:: int

static int GetMinorVersionNumber()¶

Returns Hexaly Optimizer minor version number. This number is an integer in the range [0, 9].

Returns:: Minor version number.
Return type:: int

static int GetBuildDate()¶

Returns Hexaly Optimizer build date. This number is an integer YYYYMMDD with YYYY the year, MM the month, DD the day.

Returns:: Build date.
Return type:: int

static int GetPlatform()¶

Returns the platform of the Hexaly Optimizer binary as a string. The format of the string is PPPPXX where PPPP is the platform (Win, Linux or MacOS) and XX is the architecture (32 or 64 bits).

Since:: 3.0
Returns:: Platform as string.
Return type:: string

static string GetVersion()¶

Returns Hexaly Optimizer version as a string. The format of the string is: MA.MI.YYYYMMDD-PPPPXX with MA the major number version, MI the minor number version, YYYY the year, MM the month, DD the day, PPPP the platform (Win, Linux or MacOS) and XX the architecture (32 or 64 bits)

Returns:: Version as string MA.MI.YYYYMMDD-PPPPXX
Return type:: string

static int GetVersionCode()¶

Returns Hexaly Optimizer version code as an integer in the range [0, 29999]. The version code is computed as follows: MA * 10 + MI with MA the major number version, MI the minor number version. Note that the version code can be encoded as a 16-bit integer.

Returns:: Version code
Return type:: int

static string GetCopyright()¶

Returns Hexaly Optimizer copyright as a string.

Returns:: Copyright notice.
Return type:: string

static string GetInfo()¶

Returns version and copyright info as a string.

Returns:: Version and copyright info.
Return type:: string

static string GetLicensePath()¶

Returns the license path of Hexaly Optimizer. By default, Hexaly Optimizer looks for a license in the following locations, in that order:

A file specified by a call to HxVersion.SetLicensePath(string).
The HX_LICENSE_PATH environment variable.
The deprecated LS_LICENSE_PATH environment variable.
A license.dat file in the current directory.
In the default global location (c:\\hexaly\\license.dat on
Windows, /opt/hexaly/license.dat on Linux and macOS.
In the deprecated LocalSolver global location
(c:\localsolver\license.dat on Windows, /opt/localsolver/license.dat on Linux and macOS).

For windows users: If you used the installer to setup Hexaly, the HX_LICENSE_PATH environment variable is already defined and points to the license file present in the installation folder.

Note: The license content can also be set directly with HxVersion.SetLicenseContent(string) or with the HX_LICENSE_CONTENT environment variable and this definition will have priority over the license file. The old environment variable LS_LICENSE_CONTENT can also be used, but its usage is deprecated.

Since:: 3.0
Returns:: Path to the license
Return type:: string
See:: HxVersion.SetLicensePath(string)
See:: HxVersion.GetLicenseContent()
See:: HxVersion.SetLicenseContent(string)

static void SetLicensePath(string path)¶

Change the license path used by Hexaly Optimizer.

Since:: 3.0
Arguments:: path (string) – New path for the license
See:: HxVersion.GetLicensePath()
See:: HxVersion.GetLicenseContent()
See:: HxVersion.SetLicenseContent(string)

static string GetLicenseContent()¶

Returns the license content previously set with HxVersion.SetLicenseContent or the HX_LICENSE_CONTENT environment variable.

Since:: 5.0
Returns:: The content of the license or an empty string if the content was not set.
Return type:: string
See:: HxVersion.SetLicenseContent(string)
See:: HxVersion.GetLicensePath()
See:: HxVersion.SetLicensePath(string)

static void SetLicenseContent(string licenseContent)¶

Change the license content. By default, Hexaly Optimizer tries to get the license content from the HX_LICENSE_CONTENT environment variable or from the file specified in HxVersion.SetLicensePath or in a default location. Use this function to set the license content directly, without using a file.

Since:: 5.0
Arguments:: licenseContent (string) – content of the license to use.
See:: HxVersion.GetLicenseContent()
See:: HxVersion.GetLicensePath()
See:: HxVersion.SetLicensePath(string)