SupportError Class Reference

This class models Support errors and warnings. More...

List of all members.

Public Member Functions

simba_int32 GetColNumber () const
 Get the column number.
DiagState GetDiagState () const
 Get the DiagState for this Support error.
const simba_wstringGetMsgKey () const
 Get the message key.
simba_signed_native GetRowNumber () const
 Get the row number.
 SupportError (SupportErrorType in_errType, simba_signed_native in_rowNumber, simba_int32 in_colNumber)
 Constructor.
 SupportError (SupportErrorType in_errType)
 Type conversion constructor.
 ~SupportError ()
 Destructor.

Detailed Description

This class models Support errors and warnings.

Multiple SupportErrors might correspond to the same DiagState. Also, Support warnings are also modeled by this class.


Constructor & Destructor Documentation

SupportError ( SupportErrorType  in_errType  ) 

Type conversion constructor.

This constructor is made implicit so that an object of this class can be easily created with a SupportErrorType. For example, one only needs to do the following to throw a SupportException,

 throw SupportException(SI_ERR_STRING_RIGHT_TRUNC);
Parameters:
in_errType The number that identifies this Support error.
SupportError ( SupportErrorType  in_errType,
simba_signed_native  in_rowNumber,
simba_int32  in_colNumber 
)

Constructor.

This constructor is made implicit so that an object of this class can be easily created with an SEDiagnosticID.

Parameters:
in_errType The number that identifies this Support error.
in_colNumber Column for the error. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
in_rowNumber Row for the error. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
~SupportError (  ) 

Destructor.


Member Function Documentation

simba_int32 GetColNumber (  )  const

Get the column number.

Returns:
the column number.
DiagState GetDiagState (  )  const

Get the DiagState for this Support error.

Returns:
the DiagState for this Support error.
const simba_wstring& GetMsgKey (  )  const

Get the message key.

Returns:
A reference to the message key.
simba_signed_native GetRowNumber (  )  const

Get the row number.

Returns:
the row number.

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba