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

uima::ErrorContext Class Reference

List of all members.

Detailed Description

Class ErrorContext: this is a helper class for main class Exception.

It stores context information about an information: What the program tried, when an error occurred, the file where this occured etc. in short: where, why, how it went wrong.

It should rarely be necessary to use this class directly, since most of the exceptions are designed to be used via macros, that will take care of creating context objects for you.


Public Member Functions

 ErrorContext (const ErrorMessage &clMsg=ErrorMessage(), const char *pszFilename=0, const char *pszFunction=0, unsigned long ulLineNumber=0)
 Constructor.
const ErrorMessagegetMessage () const
 accessor for the text
const char * getFileName () const
 accessor for the file name
const char * getFunctionName () const
 accessor for the function name
unsigned long getLineNumber () const
 accessor for the line number
std::string asString () const
 formatted for error output of the context to string


Constructor & Destructor Documentation

uima::ErrorContext::ErrorContext const ErrorMessage clMsg = ErrorMessage(),
const char *  pszFilename = 0,
const char *  pszFunction = 0,
unsigned long  ulLineNumber = 0
 

Constructor.


Member Function Documentation

const ErrorMessage & uima::ErrorContext::getMessage  )  const [inline]
 

accessor for the text

const char * uima::ErrorContext::getFileName  )  const [inline]
 

accessor for the file name

const char * uima::ErrorContext::getFunctionName  )  const [inline]
 

accessor for the function name

unsigned long uima::ErrorContext::getLineNumber  )  const [inline]
 

accessor for the line number

std::string uima::ErrorContext::asString  )  const
 

formatted for error output of the context to string


The documentation for this class was generated from the following file:
Generated on Mon Oct 1 16:04:13 2012 for UIMACPP API by  doxygen 1.3.9.1