HxException Class¶

class Hexaly.Optimizer.HxException¶

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

See:	HxErrorCode

Summary¶

Methods¶
`GetFileName`	Gets the name of the Hexaly source file where the exception is thrown.
`GetLineNumber`	Gets the line number in the Hexaly source file where the exception is thrown.
`GetFunctionName`	Gets the name of the function where the exception is thrown.
`GetExplanation`	Gets the explanation about the exception.
`GetMessage`	Returns a string message with all useful info about the current exception.
`GetErrorCode`	Returns the error code associated to this exception.
`ToString`	Same as GetMessage().

string GetFileName()¶

Gets the name of the Hexaly source file where the exception is thrown. Only useful for Hexaly’s maintenance team.

Returns:	File name.
Return type:	`string`

int GetLineNumber()¶

Gets the line number in the Hexaly source file where the exception is thrown. Only useful for Hexaly’s maintenance team.

Returns:	Line number.
Return type:	`int`

string GetFunctionName()¶

Gets the name of the function where the exception is thrown.

Returns:	Function name.
Return type:	`string`

string GetExplanation()¶

Gets the explanation about the exception.

Returns:	Explanation.
Return type:	`string`

string GetMessage()¶

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

Returns:	Exception message.
Return type:	`string`

HxErrorCode GetErrorCode()¶

Returns the error code associated to this exception.

Returns:	Error code.
Return type:	HxErrorCode

string ToString()¶

Same as GetMessage().

Returns:	Exception message.
Return type:	`string`