localsolver.LSVersion Class Reference

Detailed Description

Version and copyright info.

Static Public Member Functions
static int	GetMajorVersionNumber ()
	Returns LocalSolver's major version number.
static int	GetMinorVersionNumber ()
	Returns LocalSolver's minor version number.
static int	GetBuildDate ()
	Returns LocalSolver's build date.
static string	GetPlatform ()
	Returns the platform of the LocalSolver's binary as a string.
static string	GetVersion ()
	Returns LocalSolver's version as a string.
static int	GetVersionCode ()
	Returns LocalSolver's version code as an integer in the range [0, 29999].
static string	GetCopyright ()
	Returns LocalSolver's copyright as a string.
static string	GetInfo ()
	Returns version and copyright info as a string.
static string	GetLicensePath ()
	Returns the license path of LocalSolver.
static void	SetLicensePath (string licensePath)
	Change the license path used by LocalSolver.
static string	GetLicenseContent ()
	Returns the license content previously set with SetLicenseContent.
static void	SetLicenseContent (string licenseContent)
	Change the license content.

Member Function Documentation

static int localsolver.LSVersion.GetMajorVersionNumber ( )

inlinestatic

Returns LocalSolver's major version number.

This number is an integer in the range [0, 2999].

Returns

Major version number.

static int localsolver.LSVersion.GetMinorVersionNumber ( )

inlinestatic

Returns LocalSolver's minor version number.

This number is an integer in the range [0, 9].

Returns

Minor version number.

static int localsolver.LSVersion.GetBuildDate ( )

inlinestatic

Returns LocalSolver's build date.

This number is an integer YYYYMMDD with YYYY the year, MM the month, DD the day.

Returns

Build date.

static string localsolver.LSVersion.GetPlatform ( )

inlinestatic

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).

Returns

Platform as string.

Since version 3.0

static string localsolver.LSVersion.GetVersion ( )

inlinestatic

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.

Returns

Version as string "MA.MI.YYYYMMDD-PPPPXX".

static int localsolver.LSVersion.GetVersionCode ( )

inlinestatic

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.

Returns

Version code.

static string localsolver.LSVersion.GetCopyright ( )

inlinestatic

Returns LocalSolver's copyright as a string.

Returns

Copyright notice.

static string localsolver.LSVersion.GetInfo ( )

inlinestatic

Returns version and copyright info as a string.

Returns

Version and copyright info.

static string localsolver.LSVersion.GetLicensePath ( )

inlinestatic

Returns the license path of LocalSolver.

By default, LocalSolver looks for the license in 4 different locations :

1. In the file specified by setLicensePath.
2. In the current directory. If a file 'license.dat' exists, it is used as default license.
3. In the environment variable LS_LICENSE_PATH.
4. In the default location (c:.dat on windows, /opt/localsolver_X_Y/license.dat on Linux and Mac OS)

Use SetLicensePath to change the license path at runtime.

Returns

Path to the license

LSVersion.SetLicensePath LSVersion.GetLicenseContent LSVersion.SetLicenseContent Since version 3.0

static void localsolver.LSVersion.SetLicensePath ( string  licensePath )

inlinestatic

Change the license path used by LocalSolver.

Parameters

licensePath

new path for the license

LSVersion.GetLicensePath LSVersion.SetLicenseContent LSVersion.GetLicenseContent Since version 3.0

static string localsolver.LSVersion.GetLicenseContent ( )

inlinestatic

Returns the license content previously set with SetLicenseContent.

Returns

The content of the license or an empty string if the content was not set.

LSVersion.SetLicenseContent LSVersion.GetLicensePath LSVersion.SetLicensePath Since version 5.0

static void localsolver.LSVersion.SetLicenseContent ( string  licenseContent )

inlinestatic

Change the license content.

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

Parameters

licenseContent

content of the license to use.

LSVersion.GetLicenseContent LSVersion.SetLicensePath LSVersion.GetLicensePath Since version 5.0