Overview   Class List   Class Hierarchy   Class Members   Functions & Constants   Defines   Header Files  

uima::ErrorMessage Class Reference

List of all members.


Detailed Description

Class ErrorMessage: this is a helper class for main class ErrorInfo and ErrorContext.

It bundles a message id and optional a list of string parameters for the message.

Public Member Functions

 ErrorMessage (TyMessageId utMsgId=0)
 Constructor with just the message id.
 ErrorMessage (TyMessageId utMsgId, long lParam1)
 Constructor with a single long parameter.
 ErrorMessage (TyMessageId utMsgId, unsigned long ulParam1)
 Constructor with a single unsigned long parameter.
 ErrorMessage (TyMessageId utMsgId, int iParam1)
 Constructor with a single int parameter.
 ErrorMessage (TyMessageId utMsgId, unsigned int uiParam1)
 Constructor with a single unsigned int parameter.
 ErrorMessage (TyMessageId utMsgId, const char *cpszParam1)
 Constructor with a single char * parameter.
 ErrorMessage (TyMessageId utMsgId, const std::string &crstrParam1)
 Constructor with a single string parameter.
 ErrorMessage (TyMessageId utMsgId, const UChar *cpuszParam1)
 Constructor with a single UChar * parameter.
 ErrorMessage (TyMessageId utMsgId, const icu::UnicodeString &crustrParam1)
 Constructor with a single UnicodeString parameter.
 ErrorMessage (TyMessageId utMsgId, const double dParam1)
 Constructor with a single double parameter.
 ErrorMessage (TyMessageId utMsgId, const std::vector< std::string > &crvecParams)
 Constructor with a full parameter vector.
template<class T>
void addParam (T p)
TyMessageId getMessageID () const
 accessor for the message id
const std::vector< std::string > & getMessageParams () const
 accessor for the file name
std::string asString () const
 formatted for error output of the context to string
void reset (void)
 Reset method for clearing any error notifications.


Constructor & Destructor Documentation

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId = 0  ) 

Constructor with just the message id.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
long  lParam1 
)

Constructor with a single long parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
unsigned long  ulParam1 
)

Constructor with a single unsigned long parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
int  iParam1 
)

Constructor with a single int parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
unsigned int  uiParam1 
)

Constructor with a single unsigned int parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const char *  cpszParam1 
)

Constructor with a single char * parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const std::string &  crstrParam1 
)

Constructor with a single string parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const UChar *  cpuszParam1 
)

Constructor with a single UChar * parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const icu::UnicodeString &  crustrParam1 
)

Constructor with a single UnicodeString parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const double  dParam1 
)

Constructor with a single double parameter.

uima::ErrorMessage::ErrorMessage ( TyMessageId  utMsgId,
const std::vector< std::string > &  crvecParams 
)

Constructor with a full parameter vector.


Member Function Documentation

template<class T>
void uima::ErrorMessage::addParam ( p  )  [inline]

TyMessageId uima::ErrorMessage::getMessageID (  )  const [inline]

accessor for the message id

const std::vector< std::string >& uima::ErrorMessage::getMessageParams (  )  const [inline]

accessor for the file name

std::string uima::ErrorMessage::asString (  )  const

formatted for error output of the context to string

void uima::ErrorMessage::reset ( void   ) 

Reset method for clearing any error notifications.


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

Generated on Mon Oct 1 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6