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.

HxError Class

class hexaly.optimizer.HxError

Hexaly Optimizer exception. If an error occurred, Hexaly Optimizer throws a specific exception which contains useful info for debugging purposes.

Summary

Attributes

file_name

Name of the Hexaly source file where the exception is thrown.

function_name

Name of the function where the exception is thrown.

explanation

Explanation about the exception.

line_number

Line number in the Hexaly source file where the exception is thrown.

error_code

Error code associated to this exception.

message

A message with all useful info about the current exception.

Special methods

__str__

Returns a message with all useful info about the current exception.

Instance attributes

HxError.file_name

Name of the Hexaly source file where the exception is thrown. Only useful for Hexaly’s maintenance team. This attribute is read-only.

HxError.function_name

Name of the function where the exception is thrown. This attribute is read-only.

HxError.explanation

Explanation about the exception. This attribute is read-only.

HxError.line_number

Line number in the Hexaly source file where the exception is thrown. Only useful for Hexaly’s maintenance team. This attribute is read-only.

HxError.error_code

Error code associated to this exception. This attribute is read-only

HxError.message

A message with all useful info about the current exception. This attribute is read-only

Special operators and methods

HxError.__str__()

Returns a message with all useful info about the current exception. The returned string is similat to the attribute message.

Returns:

A message with all useful info about the exception

Return type:

str