Public Member Functions | List of all members
Celartem::PlatformException Class Reference

#include <cel_errutil.h>

Inheritance diagram for Celartem::PlatformException:
Inheritance graph
[legend]

Public Member Functions

 PlatformException (size_t inPlatformErrorCode, GeneralErrorDefinition inError, const String &inErrorDesc, const char *inFileName, int inLine, const char *inFuncName="")
 
size_t getPlatformErrorCode () const
 
String getPlatformErrorDescription () const
 
- Public Member Functions inherited from Celartem::Exception
 Exception (GeneralErrorDefinition inError, const char *inErrorDesc, const char *inFileName, int inLine, const char *inFuncName="")
 
 Exception (GeneralErrorDefinition inError, const String &inErrorDesc, const char *inFileName, int inLine, const char *inFuncName="")
 
 Exception (const Exception &inException)
 
Exceptionoperator= (const Exception &inException)
 
GeneralErrorDefinition getError () const
 
String getMessage () const
 
virtual const char * what () const throw ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Celartem::Exception
static void setOnExceptionCallback (void(*onExcepionCallback)(const Exception &))
 

Detailed Description

Special Exception class for platform errors.

Constructor & Destructor Documentation

Celartem::PlatformException::PlatformException ( size_t  inPlatformErrorCode,
GeneralErrorDefinition  inError,
const String inErrorDesc,
const char *  inFileName,
int  inLine,
const char *  inFuncName = "" 
)
inline

Create a new Exception. This constructor should not be called directly, you had better use celThrowOSError, celThrowOSError_1 macros.

Parameters
inPlatformErrorCodeOS error code.
inErrorAn error code defined in GeneralErrorDefinition.
inErrorDescA string that represents the details of the error status.
inFileNameA filename of the source file that contains the caller. Usually, you should set FILE macro.
inLineA line number in the source file that contains the caller. Usually, you should set LINE macro.
inFuncNameThe name of the function that throws this exception. You can set FUNCTION macro for this parameter.
See Also
celThrow, celThrow2

Member Function Documentation

size_t Celartem::PlatformException::getPlatformErrorCode ( ) const
inline

Get associated platform error code.

Returns
Platform error code.
String Celartem::PlatformException::getPlatformErrorDescription ( ) const
inline

This function returns the string that is mapped to the current error status.

Returns
The string that represents the error.

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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo