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

uima::util::Trace Class Reference

List of all members.

Detailed Description

The class util::Trace is used to send information about function execution and data (trace events) to a trace buffer.

Information will be sent only if the trace is enabled.

Note:
An object of class util::Trace must be instantiated with UIMA_TRACE_ORIGIN as an argument! 
       foo(unsigned int uiAValue, const char * cpszBValue)
       {
          util::Trace              clTrace(util::EnTraceDetailLow, UIMA_TRACE_ORIGIN, COMPONENT_FOO);

          // your code here ...

          clTrace.dump(EnTraceDetailHigh, "AValue [before]", uiAValue);
          clTrace.dump(EnTraceDetailHigh, "BValue [before]", cpszBValue);

          // your code here ...

          clTrace.dump("AValue", uiAValue);
          clTrace.dump("BValue", cpszBValue);

          // your code here ...

       }


Public Member Functions

Constructors
 Trace (EnTraceDetail enDetail, const char *cpszOrigin, uima::TyComponentId utCompId=UIMA_TRACE_COMPONENT_ID_UNDEFINED)
 create a trace with the specified level of details and an optional component id.
Properties
bool isEnabled (void) const
 return TRUE if the trace is enabled
Dump Methods
void dump (const TCHAR *cpszMessage)
 dump data into the trace using the detail level set as a default by constructor.
void dump (const TCHAR *cpszMessage, const TCHAR *cpszValue)
void dump (const TCHAR *cpszMessage, const void *cpvValue, size_t uiSize)
void dump (const TCHAR *cpszMessage, bool bValue)
void dump (const TCHAR *cpszMessage, char cValue)
void dump (const TCHAR *cpszMessage, unsigned char ucValue)
void dump (const TCHAR *cpszMessage, short sValue)
void dump (const TCHAR *cpszMessage, unsigned short usValue)
void dump (const TCHAR *cpszMessage, int iValue)
void dump (const TCHAR *cpszMessage, unsigned int uiValue)
void dump (const TCHAR *cpszMessage, long lValue)
void dump (const TCHAR *cpszMessage, unsigned long ulValue)
void dump (const TCHAR *cpszMessage, float fValue)
void dump (const TCHAR *cpszMessage, double dValue)
void dump (const TCHAR *cpszMessage, long double ldValue)
void dumpAdrs (const TCHAR *cpszMessage, const void *cpvValue)
 dump the address into the trace using the detail level set as a default by constructor.
void dumpUnicode (const char *cpszMessage, const void *cpvValue, size_t uiLength)
 dump the specified data as UNICODE data into the trace using the detail level set as a default by constructor.
void dumpBool (const TCHAR *cpszMessage, bool bValue)
 dump boolean data into the trace using a specific detail level.
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage)
 dump data into the trace using a specific detail level.
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, const TCHAR *cpszValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, const void *cpvValue, size_t uiSize)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, bool bValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, char cValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, unsigned char ucValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, short sValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, unsigned short usValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, int iValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, unsigned int uiValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, long lValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, unsigned long ulValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, float fValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, double dValue)
void dump (EnTraceDetail enDetail, const TCHAR *cpszMessage, long double ldValue)
void dumpAdrs (EnTraceDetail enDetail, const TCHAR *cpszMessage, const void *cpvValue)
 dump the address into the trace using the specified detail level
void dumpUnicode (EnTraceDetail enDetail, const char *cpszMessage, const void *cpvValue, size_t uiLength)
 dump the specified data as UNICODE data into the trace using the specified detail level
Miscelleanous
void flush (void)
 flush the trace entries so that they are written to the trace file

Constructor & Destructor Documentation

uima::util::Trace::Trace (  EnTraceDetail  enDetail,
const char *  cpszOrigin,
uima::TyComponentId  utCompId = UIMA_TRACE_COMPONENT_ID_UNDEFINED
)  [inline]
 

create a trace with the specified level of details and an optional component id.

Note:
Do not provide arguments for cpszFile directly, use the macro UIMA_TRACE_ORIGIN instead.

Member Function Documentation

bool uima::util::Trace::isEnabled (  void   )  const [inline]
 

return TRUE if the trace is enabled

void uima::util::Trace::dump (  const TCHAR *  cpszMessage  )  [inline]
 

dump data into the trace using the detail level set as a default by constructor.

Several different data types are available:

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
const TCHAR *  cpszValue
)  [inline]
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
const void *  cpvValue,
size_t  uiSize
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
bool  bValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
char  cValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
unsigned char  ucValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
short  sValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
unsigned short  usValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
int  iValue
)  [inline]
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
unsigned int  uiValue
)  [inline]
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
long  lValue
)  [inline]
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
unsigned long  ulValue
)  [inline]
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
float  fValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
double  dValue
) 
 

void uima::util::Trace::dump (  const TCHAR *  cpszMessage,
long double  ldValue
) 
 

void uima::util::Trace::dumpAdrs (  const TCHAR *  cpszMessage,
const void *  cpvValue
)  [inline]
 

dump the address into the trace using the detail level set as a default by constructor.

void uima::util::Trace::dumpUnicode (  const char *  cpszMessage,
const void *  cpvValue,
size_t  uiLength
) 
 

dump the specified data as UNICODE data into the trace using the detail level set as a default by constructor.

void uima::util::Trace::dumpBool (  const TCHAR *  cpszMessage,
bool  bValue
) 
 

dump boolean data into the trace using a specific detail level.

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage
)  [inline]
 

dump data into the trace using a specific detail level.

Several different data types are available:

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
const TCHAR *  cpszValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
const void *  cpvValue,
size_t  uiSize
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
bool  bValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
char  cValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
unsigned char  ucValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
short  sValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
unsigned short  usValue
)  [inline]
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
int  iValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
unsigned int  uiValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
long  lValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
unsigned long  ulValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
float  fValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
double  dValue
) 
 

void uima::util::Trace::dump (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
long double  ldValue
) 
 

void uima::util::Trace::dumpAdrs (  EnTraceDetail  enDetail,
const TCHAR *  cpszMessage,
const void *  cpvValue
)  [inline]
 

dump the address into the trace using the specified detail level

void uima::util::Trace::dumpUnicode (  EnTraceDetail  enDetail,
const char *  cpszMessage,
const void *  cpvValue,
size_t  uiLength
) 
 

dump the specified data as UNICODE data into the trace using the specified detail level

void uima::util::Trace::flush (  void   ) 
 

flush the trace entries so that they are written to the trace file

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