torc::generic::Error Class Reference

The Error object thrown by different methods of EdifOM. More...

#include <Error.hpp>

Data Structures
struct	StackFrameInfo

Public Types
typedef std::map< std::string, boost::any >	Context

Public Member Functions
	Error (MessageId inId, const Context &inContext, const std::string &inFunction, const std::string &inFile, uint32_t inLine)
	Error (MessageId inId, const std::string &inFunction, const std::string &inFile, uint32_t inLine)
	~Error () throw ()
	Error (const Error &source)
Error &	operator= (const Error &source)
const std::vector < StackFrameInfo > &	getStackTrace () const
void	setCurrentLocation (const std::string &inFunction, const std::string &inFile, uint32_t inLine)
const Context	getContextData () const
void	saveContextData (const std::string &inName, const boost::any &inSource)
const MessageId	getErrorMessageId () const

Private Attributes
std::vector< StackFrameInfo >	mStackTrace
Context	mContextData
MessageId	mErrorMessageId

Detailed Description

The Error object thrown by different methods of EdifOM.

The Error class is used to convey exception information to the user. The error object is constructed by the throwing method and propagated upwards by the calling functions.

Note

This class does not inherit from std::exception by design. Clients should keep that in mind while using this class.

Definition at line 41 of file Error.hpp.

Member Typedef Documentation

typedef std::map<std::string, boost::any> torc::generic::Error::Context

Context sensitive data for the error object. The Context map stores a boost::any inSource corresponding to a name. As the Error bubbles up, this data may be augmented by catching contexts.

Definition at line 48 of file Error.hpp.

Constructor & Destructor Documentation

torc::generic::Error::Error	(	MessageId	inId,
		const Context &	inContext,
		const std::string &	inFunction,
		const std::string &	inFile,
		uint32_t	inLine
	)

Constructor.

Parameters

[in]	inId	Error message identifier that can be used to look up the message in MessageTable.
[in]	inContext	Context data that will be saved inside this error object.
[in]	inFunction	Function name from where this exception is being thrown. This will typically be set to FUNCTION.
[in]	inFile	File name from where this exception is being thrown. This will typically be set to FILE.
[in]	inLine	Line No. in the file from where this exception is being thrown. This will typically be set to LINE.

Definition at line 42 of file Error.cpp.

                                              : mStackTrace(), mContextData(inContext),
    mErrorMessageId(inId) {
    StackFrameInfo info(inFunction, inFile, inLine);
    mStackTrace.push_back(info);
}

torc::generic::Error::Error	(	MessageId	inId,
		const std::string &	inFunction,
		const std::string &	inFile,
		uint32_t	inLine
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 52 of file Error.cpp.

                     :
    mStackTrace(), mContextData(), mErrorMessageId(inId) {
    StackFrameInfo info(inFunction, inFile, inLine);
    mStackTrace.push_back(info);
}

torc::generic::Error::~Error	(		)
throw	(
	)

Definition at line 59 of file Error.cpp.

{}

torc::generic::Error::Error

(

const Error &

source

)

Definition at line 61 of file Error.cpp.

                                : mStackTrace(source.mStackTrace),
    mContextData(source.mContextData), mErrorMessageId(source.mErrorMessageId) {}

Member Function Documentation

const Error::Context torc::generic::Error::getContextData ( ) const

inline

Get the map of context data for this exception. This can be looked up by interested parties for context sensitive information. Note that the value_type for this map is boost::any and therefore an appropriate boost::any_cast is required to get the actual data.

Returns

const reference to a Context object.

Definition at line 186 of file Error.hpp.

                                                      {
    return mContextData;
}

const MessageId torc::generic::Error::getErrorMessageId ( ) const

inline

Get the error message Id for this error.

Returns

MessageId corresponding to this error

Definition at line 195 of file Error.hpp.

                                                      {
    return mErrorMessageId;
}

Here is the caller graph for this function:

const std::vector< Error::StackFrameInfo > & torc::generic::Error::getStackTrace ( ) const

inline

Get the complete stack trace.

Returns

vector containing the StackFrameInfo objects.

Definition at line 175 of file Error.hpp.

                                                                        {
    return mStackTrace;
}

Here is the caller graph for this function:

Error & torc::generic::Error::operator=

(

const Error &

source

)

Definition at line 64 of file Error.cpp.

                                           {
    if(this != &source) {
        mStackTrace = source.mStackTrace;
        mContextData = source.mContextData;
        mErrorMessageId = source.mErrorMessageId;
    }
    return *this;
}

void torc::generic::Error::saveContextData	(	const std::string &	inName,
		const boost::any &	inSource
	)

Save a context sensitive data with a meaningful name, that can be retreived by interested catching contexts.

Parameters

[in]	inName	Name of the data.
[in]	inSource	Any type of data. The only restrictions are that the type of data should be copy constructible and assignable.

Definition at line 79 of file Error.cpp.

                                                                             {
    mContextData[inName] = inSource;
}

void torc::generic::Error::setCurrentLocation	(	const std::string &	inFunction,
		const std::string &	inFile,
		uint32_t	inLine
	)

Set the current location. This method should be used by catching contexts to push location data into the error object.

Parameters

[in]	inFunction	Function name from where this exception is being thrown. This will typically be set to FUNCTION.
[in]	inFile	File name from where this exception is being thrown. This will typically be set to FILE.
[in]	inLine	Line No. in the file from where this exception is being thrown. This will typically be set to LINE.

Definition at line 73 of file Error.cpp.

                     {
    StackFrameInfo info(inFunction, inFile, inLine);
    mStackTrace.push_back(info);
}

Field Documentation

Context torc::generic::Error::mContextData

private

Definition at line 154 of file Error.hpp.

MessageId torc::generic::Error::mErrorMessageId

private

Definition at line 155 of file Error.hpp.

std::vector<StackFrameInfo> torc::generic::Error::mStackTrace

private

Definition at line 153 of file Error.hpp.

---

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

• Error.hpp
• Error.cpp