Raytrix exception base class. All exceptions are based on this class.
Inherits IException31.
Inherited by Rx::ApiLF::CRxApiException, Rx::CRxErrnoException, Rx::CRxFileNotFoundException, Rx::CRxOperatingSystemException, and Rx::CRxOutOfMemoryException.
|
| CRxException (const CRxString &sxMsg, const char *pcFile, const char *pcFunc, int iLine) |
| Constructor. More...
|
|
| CRxException (const CRxString &sxMsg, const char *pcFile, const char *pcFunc, int iLine, const IException30 &xEx) |
| Constructor. More...
|
|
| CRxException (const CRxString &sxMsg, const char *pcFile, const char *pcFunc, int iLine, const IException31 &xEx) |
| Constructor. More...
|
|
virtual const char * | GetFile () const |
| Gets the file name. More...
|
|
virtual const char * | GetFunction () const |
| Gets the function name. More...
|
|
virtual const CGuid30 & | GetGUID () const |
| Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type. More...
|
|
virtual const IException31 * | GetInnerException () const |
| Gets the inner exception if one is available. Otherwise nullptr is returned. More...
|
|
virtual int | GetLine () const |
| Gets the line. More...
|
|
virtual const char * | GetMessageText () const |
| Gets message text. More...
|
|
virtual const char * | GetName () const |
| Gets the name of this exception. More...
|
|
template<class TException > |
bool | HasException () const |
| Query if this exception or one of its inner exceptions contains an exception of the given type. More...
|
|
virtual bool | HasException (const CGuid30 &xGUID) const |
| Query if this exception or one of its inner exceptions contains an exception of the given GUID. More...
|
|
| RX_EXCEPTION_BASE_IMPLEMENTATION (CRxException,"Rx.RxException","{491260D2-0D75-4CCD-A2C5-46428B450B66}") |
|
virtual void | SetExceptionData () |
| Sets additional exception data. More...
|
|
void | SetGUID (const CGuid30 &xGUID) |
| Sets the GUID of this exception. This is not guaranteed to be the GUID of this exception type. More...
|
|
void | SetInnerException (const IException31 &xEx) |
| Sets the given exception as the inner exception. More...
|
|
virtual CRxString | ToString () const |
| Convert this exception into a string representation. More...
|
|
CRxString | ToString (bool bIncludeInner) const |
| Convert this exception into a string representation. More...
|
|
Rx::CRxException::CRxException |
( |
const CRxString & |
sxMsg, |
|
|
const char * |
pcFile, |
|
|
const char * |
pcFunc, |
|
|
int |
iLine |
|
) |
| |
Constructor.
- Parameters
-
sxMsg | The message string. |
pcFile | The file. |
pcFunc | The function. |
iLine | The line. |
Rx::CRxException::CRxException |
( |
const CRxString & |
sxMsg, |
|
|
const char * |
pcFile, |
|
|
const char * |
pcFunc, |
|
|
int |
iLine, |
|
|
const IException30 & |
xEx |
|
) |
| |
Constructor.
- Parameters
-
sxMsg | The message string. |
pcFile | The file. |
pcFunc | The function. |
iLine | The line. |
xEx | The inner exception. |
Rx::CRxException::CRxException |
( |
const CRxString & |
sxMsg, |
|
|
const char * |
pcFile, |
|
|
const char * |
pcFunc, |
|
|
int |
iLine, |
|
|
const IException31 & |
xEx |
|
) |
| |
Constructor.
- Parameters
-
sxMsg | The message string. |
pcFile | The file. |
pcFunc | The function. |
iLine | The line. |
xEx | The inner exception. |
virtual const char* Rx::CRxException::GetFile |
( |
| ) |
const |
|
virtual |
Gets the file name.
- Returns
- The file name.
virtual const char* Rx::CRxException::GetFunction |
( |
| ) |
const |
|
virtual |
Gets the function name.
- Returns
- The function name.
virtual const CGuid30& Rx::CRxException::GetGUID |
( |
| ) |
const |
|
virtual |
Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type.
- Returns
- The unique identifier.
virtual const IException31* Rx::CRxException::GetInnerException |
( |
| ) |
const |
|
virtual |
Gets the inner exception if one is available. Otherwise nullptr is returned.
- Returns
- The inner exception.
virtual int Rx::CRxException::GetLine |
( |
| ) |
const |
|
virtual |
Gets the line.
- Returns
- The line number.
virtual const char* Rx::CRxException::GetMessageText |
( |
| ) |
const |
|
virtual |
Gets message text.
- Returns
- Null if it fails, else the message text.
virtual const char* Rx::CRxException::GetName |
( |
| ) |
const |
|
virtual |
Gets the name of this exception.
- Returns
- The name of this exception.
template<class TException >
bool Rx::CRxException::HasException |
( |
| ) |
const |
|
inline |
Query if this exception or one of its inner exceptions contains an exception of the given type.
- Template Parameters
-
TException | The exception type to test for. |
- Returns
- True if this exception or one of its inner exceptions contains an exception of the given type, false if not.
virtual bool Rx::CRxException::HasException |
( |
const CGuid30 & |
xGUID | ) |
const |
|
virtual |
Query if this exception or one of its inner exceptions contains an exception of the given GUID.
- Parameters
-
xGUID | [in] The GUID of the exception to look for. |
- Returns
- True if this exception or one of its inner exceptions contains an exception of the given GUID, false if not.
Rx::CRxException::RX_EXCEPTION_BASE_IMPLEMENTATION |
( |
CRxException |
, |
|
|
"Rx.RxException" |
, |
|
|
"{491260D2-0D75-4CCD-A2C5-46428B450B66}" |
|
|
) |
| |
virtual void Rx::CRxException::SetExceptionData |
( |
| ) |
|
|
virtual |
void Rx::CRxException::SetGUID |
( |
const CGuid30 & |
xGUID | ) |
|
|
inline |
Sets the GUID of this exception. This is not guaranteed to be the GUID of this exception type.
- Parameters
-
void Rx::CRxException::SetInnerException |
( |
const IException31 & |
xEx | ) |
|
|
inline |
Sets the given exception as the inner exception.
- Parameters
-
virtual CRxString Rx::CRxException::ToString |
( |
| ) |
const |
|
virtual |
Convert this exception into a string representation.
- Returns
- This exception as a string.
CRxString Rx::CRxException::ToString |
( |
bool |
bIncludeInner | ) |
const |
Convert this exception into a string representation.
- Parameters
-
bIncludeInner | True to include all inner exceptions. |
- Returns
- This exception as a string.