localsolver.LSException Class Reference

Detailed Description

LocalSolver exception.

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

Public Member Functions
String	GetFileName ()
	Gets the name of the LocalSolver source file where the exception is thrown.
int	GetLineNumber ()
	Gets the line number in the LocalSolver source file where the exception is thrown.
String	GetFunctionName ()
	Gets the name of the function where the exception is thrown.
String	GetExplanation ()
	Gets the explanation about the exception.
String	GetMessage ()
	Returns a string message with all useful info about the current exception.
LSErrorCode	GetErrorCode ()
	Returns the error code associated to this exception.
override string	ToString ()
	Same as getMessage().

Member Function Documentation

String localsolver.LSException.GetFileName ( )

inline

Gets the name of the LocalSolver source file where the exception is thrown.

Only useful for LocalSolver's maintenance team.

Returns

File name.

int localsolver.LSException.GetLineNumber ( )

inline

Gets the line number in the LocalSolver source file where the exception is thrown.

Only useful for LocalSolver's maintenance team.

Returns

Line number.

String localsolver.LSException.GetFunctionName ( )

inline

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

Returns

Function name.

String localsolver.LSException.GetExplanation ( )

inline

Gets the explanation about the exception.

Returns

Explanation.

String localsolver.LSException.GetMessage ( )

inline

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

Returns

Exception message.

LSErrorCode localsolver.LSException.GetErrorCode ( )

inline

Returns the error code associated to this exception.

Returns

Error code.

override string localsolver.LSException.ToString ( )

inline

Same as getMessage().