torc::generic::MessageTable Class Reference

#include <MessageTable.hpp>

Public Types
typedef std::map< MessageId, Message >	MessageContainer

Public Member Functions
std::string	getMessage (MessageId inId) const
void	changeMessageString (MessageId inId, const Message &inMessage) throw (Error)
void	changeMessageSeverity (MessageId inId, MessageSeverity inSeverity)
	~MessageTable () throw ()

Static Public Member Functions
static MessageTable *	instance ()

Private Member Functions
	MessageTable ()
	MessageTable (const MessageTable &source)
MessageTable &	operator= (const MessageTable &source)
void	operator delete (void *)

Private Attributes
MessageContainer	mMessages

Detailed Description

Table of messages for this library. This is used for retrieving a message for a given MessageId.

Note

getMessage method is a read only method, and as such it is thread-safe. However, the changeMessageSeverity() and changeMessageSeverity() are not thread-safe. Typically they are not meant to be used in a multi-threaded context. If required however, for some reason, they need to be protected by proper locking contexts

Definition at line 35 of file MessageTable.hpp.

Member Typedef Documentation

typedef std::map<MessageId, Message> torc::generic::MessageTable::MessageContainer

Definition at line 37 of file MessageTable.hpp.

Constructor & Destructor Documentation

torc::generic::MessageTable::MessageTable ( )

explicitprivate

Definition at line 99 of file MessageTable.cpp.

                           : mMessages() {
    //Populate message table
    mMessages[eMessageIdErrorArrayIndexSizeMismatch] = Message(
        "Array index size does not match array dimensions", eMessageSeverityError);

    mMessages[eMessageIdErrorArrayIndexOutOfBounds] = Message("Array index out of bounds",
        eMessageSeverityError);

    mMessages[eMessageIdErrorEmptyArray] = Message("Empty array", eMessageSeverityError);

    mMessages[eMessageIdErrorNullChildfactory] = Message("Null child factory",
        eMessageSeverityError);

    mMessages[eMessageIdErrorEmptyItemName] = Message("Empty item name", eMessageSeverityError);

    mMessages[eMessageIdErrorItemAlreadyExists] = Message("Item already exists",
        eMessageSeverityError);

    mMessages[eMessageIdErrorItemNotFound] = Message("Item not found", eMessageSeverityError);

    mMessages[eMessageIdErrorPointerToItemDoesNotExist] = Message("Pointer to item does not exist",
        eMessageSeverityError);

    mMessages[eMessageIdErrorItemSizeMismatch] = Message("Item size does not match",
        eMessageSeverityError);

    mMessages[eMessageIdErrorConnectionInvalid] = Message("Provided connection is invalid",
        eMessageSeverityError);

    mMessages[eMessageIdErrorTypeCast] = Message("Type cast not possible", eMessageSeverityError);

    mMessages[eMessageIdErrorValueNotSet] = Message("Value not set", eMessageSeverityError);

    mMessages[eMessageIdErrorCompositionTypeMismatch] = Message("Composition type mismatch",
        eMessageSeverityError);
    mMessages[eMessageIdParserError] = Message("Error from parser", eMessageSeverityError);

    mMessages[eMessageIdParserWarning] = Message("Warning from parser", eMessageSeverityWarning);
    mMessages[eMessageIdErrorNullPointer] = Message("Null Pointer detected", eMessageSeverityError);
    mMessages[eMessageIdErrorUnsupoortedOperation] = Message("Operation is unsupported on class",
        eMessageSeverityError);
}

torc::generic::MessageTable::~MessageTable	(		)
throw	(
	)

Definition at line 142 of file MessageTable.cpp.

{}

torc::generic::MessageTable::MessageTable ( const MessageTable &  source )

private

Member Function Documentation

void torc::generic::MessageTable::changeMessageSeverity	(	MessageId	inId,
		MessageSeverity	inSeverity
	)

Change the message severity for a given Id.

Parameters

[in]	inId	MessageId that needs to be changed
[in]	inSeverity	New severity that needs to be set.

Definition at line 84 of file MessageTable.cpp.

                                                                                   {
    MessageContainer::const_iterator msg = mMessages.find(inId);
    if(msg != mMessages.end()) {
        mMessages[inId].setSeverity(inSeverity);
    }
}

void torc::generic::MessageTable::changeMessageString	(	MessageId	inId,
		const Message &	inMessage
	)
throw	(	Error
	)

Change the message string for a given Id.

Parameters

[in]	inId	MessageId that needs to be changed
[in]	inMessage	New message that needs to be set.

Definition at line 74 of file MessageTable.cpp.

                                                                                             {
    mMessages[inId] = inMessage;
}

std::string torc::generic::MessageTable::getMessage

(

MessageId

inId

)

const

Get the message string corresponding to the message id. This is constructed using the actual message string and the currently set severity of this message.

Parameters

[in]

inId

MessageId object to denote the message.

Returns

Formatted message string. Empty string is returned if there was some error.

Get the message string corresponding to the message inId. This is constructed using the actual message string and the currently set severity of this message.

Parameters

[in]

inId

MessageId object to denote the message.

Definition at line 34 of file MessageTable.cpp.

                                                       {
    MessageContainer::const_iterator msg = mMessages.find(inId);
    if(msg == mMessages.end()) {
        return std::string();
    }
    const Message message((*msg).second);
    char msgString[BUFSIZ];
    int nbytes = 0;
    switch(message.getSeverity()) {
    case eMessageSeveritySuppressed: {
        nbytes = snprintf(msgString, BUFSIZ, "SUPPRESSED ");
        break;
    }
    case eMessageSeverityInfo: {
        nbytes = snprintf(msgString, BUFSIZ, "INFO ");
        break;
    }
    case eMessageSeverityError: {
        nbytes = snprintf(msgString, BUFSIZ, "ERROR ");
        break;
    }
    case eMessageSeverityWarning: {
        nbytes = snprintf(msgString, BUFSIZ, "WARNING ");
        break;
    }
    }
    const std::string& actualMsg = message.getMessage();
    nbytes = snprintf(msgString + nbytes, BUFSIZ - nbytes, "%d : %s", inId, actualMsg.c_str());
    if(nbytes >= BUFSIZ) {
        return std::string();
    }
    return msgString;
}

Here is the call graph for this function:

Here is the caller graph for this function:

MessageTable * torc::generic::MessageTable::instance ( )

static

Get a pointer to the singleton MessageTable object.

Definition at line 94 of file MessageTable.cpp.

                                     {
    static MessageTable singletonObject;
    return &singletonObject;
}

Here is the caller graph for this function:

void torc::generic::MessageTable::operator delete ( void *  )

private

MessageTable& torc::generic::MessageTable::operator= ( const MessageTable &  source )

private

Field Documentation

MessageContainer torc::generic::MessageTable::mMessages

private

Definition at line 84 of file MessageTable.hpp.

---

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

• MessageTable.hpp
• MessageTable.cpp