Localsolver  6.0
localsolverblackbox.LSBBException Class Reference

Detailed Description

LocalSolverBlackBox exception.

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

Public Member Functions

string GetFileName ()
 Gets the name of the LocalSolverBlackBox source file where the exception is thrown.
int GetLineNumber ()
 Gets the line number in the LocalSolverBlackBox 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.
LSBBErrorCode GetErrorCode ()
 Returns the error code associated to this exception.
override string ToString ()
 Same as getMessage().

Member Function Documentation

string localsolverblackbox.LSBBException.GetFileName ( )

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

Only useful for LocalSolverBlackBox's maintenance team.

Returns
File name.
int localsolverblackbox.LSBBException.GetLineNumber ( )

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

Only useful for LocalSolverBlackBox's maintenance team.

Returns
Line number.
string localsolverblackbox.LSBBException.GetFunctionName ( )

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

Returns
Function name.
string localsolverblackbox.LSBBException.GetExplanation ( )

Gets the explanation about the exception.

Returns
Explanation.
string localsolverblackbox.LSBBException.GetMessage ( )

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

Returns
Exception message.
LSBBErrorCode localsolverblackbox.LSBBException.GetErrorCode ( )

Returns the error code associated to this exception.

Returns
Error code.
override string localsolverblackbox.LSBBException.ToString ( )

Same as getMessage().