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.

LSErrorCode Enumeration

class localsolver.LSErrorCode

List of error codes used by py:class:LSError.

As other enumerations present in the localsolver module, LSErrorCode is enumerable and indexable:

print (LSErrorCode[0])          # Shows LSErrorCode.API
print (LSErrorCode.API.value)   # Shows 0

# Iterates over the members of LSErrorCode
for e in LSErrorCode:
    print e
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 arg name cannot be null.
  • Argument arg name does not belong to this instance of LocalSolver.
  • Argument arg name must be positive.
  • Argument arg name 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: other type.
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.