This page is for an old version of Hexaly Optimizer. We recommend that you update your version and read the documentation for the latest stable release.

LSVersion Class

class localsolver.LSVersion

Version, license and copyright info.

Summary

Attributes
major_version_number Major version number.
minor_version_number Minor version number.
build_date Build date.
platform Platform of the LocalSolver binary.
version Version as string.
version_code Version code.
copyright LocalSolver’s copyright.
info Version and copyright info.
license_path License path.
license_content License content.
Methods
get_major_version_number Returns LocalSolver’s major version number.
get_minor_version_number Returns LocalSolver’s minor version number.
get_build_date Returns LocalSolver’s build date.
get_platform Returns the platform of the LocalSolver’s binary as a string.
get_version Returns LocalSolver’s version as a string.
get_version_code Returns LocalSolver’s version code as an integer in the range [0, 29999].
get_copyright Returns LocalSolver’s copyright as a string.
get_info Returns version and copyright info as a string.
get_license_path Returns the license path of LocalSolver.
set_license_path Change the license path used by LocalSolver.
get_license_content Returns the license content previously set with set_license_content().
set_license_content Change the license content.

Instance methods

LSVersion.get_major_version_number()

Returns LocalSolver’s major version number. This number is an integer in the range [0, 2999].

You can also use the shortcut member major_version_number

Returns:Major version number.
Return type:int
LSVersion.get_minor_version_number()

Returns LocalSolver’s minor version number. This number is an integer in the range [0, 9].

You can also use the shortcut member minor_version_number

Returns:Minor version number.
Return type:int
LSVersion.get_build_date()

Returns LocalSolver’s build date. This number is an integer YYYYMMDD with YYYY the year, MM the month, DD the day.

You can also use the shortcut member build_date

Returns:Build date
Return type:int
LSVersion.get_platform()

Returns the platform of the LocalSolver’s 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).

You can also use the shortcut member platform

Returns:Platform as string.
Return type:str
Since:3.0
LSVersion.get_version()

Returns LocalSolver’s 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.

You can also use the shortcut member version

Returns:Version as string MA.MI.YYYYMMDD-PPPPXX.
Return type:str
LSVersion.get_version_code()

Returns LocalSolver’s 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.

You can also use the shortcut member version_code

Returns:Version code.
Return type:int

Returns LocalSolver’s copyright as a string.

You can also use the shortcut member copyright

Returns:Copyright notice.
Return type:str
LSVersion.get_info()

Returns version and copyright info as a string.

You can also use the shortcut member info

Returns:Version and copyright info.
Return type:str
LSVersion.get_license_path()

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

  1. A file specified by a call to set_license_path().
  2. The LS_LICENSE_PATH environment variable.
  3. A license.dat file in the current directory.
  4. In the default location (c:\localsolver_X_Y\license.dat on Windows, /opt/localsolver_X_Y/license.dat on Linux and Mac OS).

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

You can also use the shortcut member license_path

Returns:Path to the license
Return type:str
Since:3.0
LSVersion.set_license_path(path)

Change the license path used by LocalSolver.

You can also use the shortcut member license_path

Parameters:path (str) – New path for the license
Since:3.0
LSVersion.get_license_content()

Returns the license content previously set with set_license_content().

You can also use the shortcut member license_content

Returns:The content of the license or an empty string if the content was not set.
Return type:str
Since:5.0
LSVersion.set_license_content(content)

Change the license content. By default, LocalSolver try to get the license from the path specified in set_license_path or in a default location. Use this function to set the license content directly, without using a file.

You can also use the shortcut member license_content

Parameters:content (str) – Content of the license to use.
Since:5.0

Instance attributes

All get/set methods have their attribute counterpart. You can use them as shortcuts to improve the readability or your models and codes.

LSVersion.major_version_number

Major version number. This attribute is read-only. It is a shortcut for get_major_version_number().

LSVersion.minor_version_number

Minor version number. This attribute is read-only. It is a shortcut for get_minor_version_number().

LSVersion.build_date

Build date. This attribute is read-only. It is a shortcut for get_build_date().

LSVersion.platform

Platform of the LocalSolver binary. This attribute is read-only. It is a shortcut for get_platform().

LSVersion.version

Version as string. This attribute is read-only. It is a shortcut for get_version().

LSVersion.version_code

Version code. This attribute is read-only. It is a shortcut for get_version_code().

LSVersion.copyright

LocalSolver’s copyright. This attribute is read-only. It is a shortcut for get_copyright().

LSVersion.info

Version and copyright info. This attribute is read-only. It is a shortcut for get_info().

LSVersion.license_path

License path. It is a shortcut for get_license_path() and set_license_path().

LSVersion.license_content

License content. It is a shortcut for get_license_content() and set_license_content().