Localsolver  6.0
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 ( )

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 ( )

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 ( )

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

Returns
Function name.
string localsolver.LSException.GetExplanation ( )

Gets the explanation about the exception.

Returns
Explanation.
string localsolver.LSException.GetMessage ( )

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

Returns
Exception message.
LSErrorCode localsolver.LSException.GetErrorCode ( )

Returns the error code associated to this exception.

Returns
Error code.
override string localsolver.LSException.ToString ( )

Same as getMessage().