LSErrorCode Enumeration¶

enum localsolver.LSErrorCode¶

List of error codes used by LSException.

Api¶

Code used for errors related to API functions. Used when you call a function in a wrong way or with inappropriate parameters.

Examples of error messages:

• Argument ‘argName’ cannot be null.

• Argument ‘argName’ does not belong to this instance of LocalSolver.

• Argument ‘argName’ must be positive.

• Argument ‘argName’ cannot be an empty string.

• This method is only allowed in state Modeling (the model must not be closed).

File¶

Code used when an error related to input/output operations occurs.

Examples of error messages:

• File doesn’t exist.

• File is corrupted.

• Cannot open file.

• File format is not recognized.

Model¶

Code used when a problem related to the structure of the model occurs.

Examples of error messages:

• At least one objective is required in the model.

• A cycle of length ‘n’ was detected in the model.

• Number of operands (‘n’) is too small: at least ‘m’ operands are expected for ‘operator’.

• Operand ‘n’ of ‘operator’ must be ‘type’. Type provided: ‘otherType’.

Callback¶

Code used when an error is encountered in a user callback.

License¶

Code used when a problem related to licensing occurs. That could be a problem with the license itself (expiration, hardware signature, etc.), or a problem related to input/output or networking operations.

Examples of error messages:

• Incorrect license number.

• This license key is not compatible with the current hardware. Please contact your reseller.

• Property ‘prop’ is missing in file [‘file’]

• Fail to contact the token server. Check your connection.

• This license is not compatible with the current hardware.

• No token available. All tokens are currently in use.

Solver¶

Code used when a problem occurs during the resolution.

Internal¶

Internal LocalSolver error.

Modeler¶

Code used when an error is encountered in the modeler.