LSBBErrorCode Enumeration

enum localsolverblackbox::LSBBErrorCode

List of error codes used by LSBBException.

EC_BB_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 LocalSolverBlackBox.
  • 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).

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

EC_BB_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’.

EC_BB_Callback

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

EC_BB_License

Code used when a problem related to licensing occurs.

That could be a problem with the license itself (expiration, hardware signature, ...), 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.

EC_BB_Solver

Code used when a problem occurs during the resolution such a division by zero or an index out of bounds.

Keep in mind that, during the search variables are likely to take values that do not satisfy the constraints (for instance in the feasibility stage). Consequently when an division by zero or array overflow occurs in your model, it probably means that the denominator of a modulo or the index of a array can take invalid values. You can fix this using min and max expressions for instance: z <- x % y can be replaced by z<-x % max(1,y).

Examples of error messages:

  • Division by zero.
  • Index out of bounds for ‘at’ operator (index: ‘indexId’, array size: ‘n’)

EC_BB_Internal

Internal LocalSolverBlackBox error.

EC_BB_Modeler

Code used when an error is encountered in the modeler.