CigiException Class Reference

#include <CigiException.h>

Inheritance diagram for CigiException:

List of all members.

Public Member Functions
	CigiException (void)
virtual	~CigiException (void) throw ()
bool	HasMessage (void) const
int	GetErrorCode (void) const
bool	HasErrorCode (void) const
virtual const char *	what () const throw ()
Protected Attributes
char *	Msg
int	ErrorCode

---

Detailed Description

The general base exception class for the CIGI API

Definition at line 74 of file CigiException.h.

---

Constructor & Destructor Documentation

CigiException::CigiException

(

void

)

[inline]

The general constructor for the base CIGI exception class

Definition at line 85 of file CigiException.h.

{ };

virtual CigiException::~CigiException

(

void

)

throw () [inline, virtual]

The general destructor for the base CIGI exception class

Definition at line 91 of file CigiException.h.

{ };

---

Member Function Documentation

int CigiException::GetErrorCode

(

void

)

const [inline]

Gets the error code for the exception.

Returns:

The error code for this exception.

Definition at line 111 of file CigiException.h.

{ return(ErrorCode); }

bool CigiException::HasErrorCode

(

void

)

const [inline]

Returns whether this exception has a set error code.

Returns:

True if this exception has an error code set.

Definition at line 117 of file CigiException.h.

References CIGI_ERROR_NONE.

   {
      return(ErrorCode != CIGI_ERROR_NONE); // same as CIGI_SUCCESS
   }

bool CigiException::HasMessage

(

void

)

const [inline]

Returns whether the exception has a message.

Returns:

true for having a message and false for no msg..

Definition at line 102 of file CigiException.h.

   {
      return(Msg != NULL);
   }

virtual const char* CigiException::what

(

)

const throw () [inline, virtual]

The virtual implemented what funtion.

Returns:

The message for this exception.

Definition at line 127 of file CigiException.h.

{ return(Msg); }

---

Member Data Documentation

int CigiException::ErrorCode [protected]

The error code for this exception.

Definition at line 140 of file CigiException.h.

char* CigiException::Msg [protected]

The message for this exception.

Definition at line 135 of file CigiException.h.

---

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

• ccl/include/CigiException.h

---