dlr::common::IOException Class Reference

This is an Exception class for errors in which the outside world is misbehaving. More...

#include <exception.h>

Inheritance diagram for dlr::common::IOException:

[legend]Collaboration diagram for dlr::common::IOException:

[legend]List of all members.

Public Member Functions
	IOException () throw ()
	IOException (const char *message) throw ()
	IOException (const char *message, const char *fileName, int lineNumber) throw ()
	IOException (const char *message, const char *functionName, const char *fileName, int lineNumber) throw ()
	IOException (const IOException &source) throw ()
virtual	~IOException () throw ()
virtual void	addTrace (const char *message) throw ()
	This public method appends the provided text to the internal "trace()" message.
virtual const char *	trace () const throw ()
	This public method returns a C-style string describing the accumulated trace information from the exception throw.
virtual const char *	what () const throw ()
	This public method returns a C-style string describing the condition which caused the exception to be thrown.
Protected Member Functions
	IOException (const char *message, const char *childClassName) throw ()
	IOException (const char *message, const char *childClassName, const char *functionName, const char *fileName, int lineNumber) throw ()
Protected Attributes
char	m_message [DLR_EXCEPTION_MESSAGE_LENGTH]
	This protected member is a C-style string which holds a message describing the condition which caused the exception to be thrown.
char	m_traceMessage [DLR_EXCEPTION_TRACE_REQUIRED_STACK_LEVELS *DLR_EXCEPTION_TRACE_MESSAGE_LENGTH]
	This protected member is a C-style string which holds the accumulated exception trace message.
size_t	m_traceMessageIndex
	This protected member is used to keep track of how much of m_traceMessage has been filled with stack information.

---

Detailed Description

This is an Exception class for errors in which the outside world is misbehaving.

This is also an example of how to subclass Exception without using the DLR_DECLARE_EXCEPTION_TYPE macro.

Definition at line 526 of file dlrCommon/exception.h.

---

Member Function Documentation

void dlr::common::Exception::addTrace

(

const char *

message

)

throw () [virtual, inherited]

This public method appends the provided text to the internal "trace()" message.

Note that the trace message is shared between all dlr::Exception instances, so if you use the addTrace() method of more than one exception at once, the trace message can get garbled.

Parameters:

message

This argument is a C-style string containing the text to be added.

Definition at line 230 of file exception.cpp.

References DLR_EXCEPTION_TRACE_MESSAGE_LENGTH, and DLR_EXCEPTION_TRACE_REQUIRED_STACK_LEVELS.

virtual const char* dlr::common::Exception::trace

(

)

const throw () [inline, virtual, inherited]

This public method returns a C-style string describing the accumulated trace information from the exception throw.

The value of this string is set using calls to the addTrace() method.

Returns:

The return value is a C-style string describing the condition which caused the exception to be thrown.

Definition at line 404 of file dlrCommon/exception.h.

References dlr::common::Exception::m_traceMessage.

virtual const char* dlr::common::Exception::what

(

)

const throw () [inline, virtual, inherited]

This public method returns a C-style string describing the condition which caused the exception to be thrown.

The value of this string is set during construction based on the provided constructor arguments.

Returns:

The return value is a C-style string describing the condition which caused the exception to be thrown.

Definition at line 416 of file dlrCommon/exception.h.

References dlr::common::Exception::m_message.

---

Member Data Documentation

char dlr::common::Exception::m_message[DLR_EXCEPTION_MESSAGE_LENGTH] [protected, inherited]

This protected member is a C-style string which holds a message describing the condition which caused the exception to be thrown.

Definition at line 501 of file dlrCommon/exception.h.

Referenced by dlr::common::Exception::what().

char dlr::common::Exception::m_traceMessage[DLR_EXCEPTION_TRACE_REQUIRED_STACK_LEVELS *DLR_EXCEPTION_TRACE_MESSAGE_LENGTH] [protected, inherited]

This protected member is a C-style string which holds the accumulated exception trace message.

Definition at line 509 of file dlrCommon/exception.h.

Referenced by dlr::common::Exception::trace().

size_t dlr::common::Exception::m_traceMessageIndex [protected, inherited]

This protected member is used to keep track of how much of m_traceMessage has been filled with stack information.

Definition at line 516 of file dlrCommon/exception.h.

---

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

• dlrCommon/exception.h

---