UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaTrace Class Reference

A class used for trace outputs (error, information,...). More...

#include <uatrace.h>

Inherited by LibT, and SrvT.

Public Types

enum  TraceLevel {
  NoTrace = 0, Errors, Warning, Info,
  InterfaceCall, CtorDtor, ProgramFlow, Data
}
 Definition of the TraceLevel Enumeration. More...
 

Public Member Functions

 UaTrace ()
 construction
 
virtual ~UaTrace ()
 destruction
 

Static Public Member Functions

static long initTrace (TraceLevel traceLevel, unsigned int maxTraceEntries, unsigned int NumBackupFiles, const UaString &traceFile, const UaString &appName)
 Initialize the trace. More...
 
static long changeTrace (TraceLevel traceLevel, unsigned int maxTraceEntries, unsigned int NumBackupFiles, const UaString &traceFile)
 Change the trace settings. More...
 
static long initErrorTrace (const UaString &traceFile, const UaString &appName)
 Initialize the trace. More...
 
static long setProductVersion (const UaString &appVersion)
 Get the trace level. More...
 
static TraceLevel getTraceLevel ()
 Get the trace level. More...
 
static void setLocalTimeOutput (bool isLocal)
 Set time output for trace to local time. More...
 
static void setPrintDateInTrace (bool printDateInTrace)
 Set time output for trace to print also the date. More...
 
static void setTraceHook (UaTraceHook *pTraceHook)
 Set a trace hook for all trace messages passing the configured trace level. More...
 
static void setErrorTraceHook (UaTraceHook *pErrorTraceHook)
 Set a trace hook for all error, warning and info trace messages. More...
 
static void tError (const char *fmt,...)
 Error trace output. More...
 
static void tWarning (const char *fmt,...)
 Warning trace output. More...
 
static void tInfo (const char *fmt,...)
 Info trace output. More...
 
static void tIfCall (const char *fmt,...)
 External interface call trace output. More...
 
static void tCtor (const char *fmt,...)
 Ctor and Dtor trace output. More...
 
static void tInOut (const char *fmt,...)
 Program flow trace output. More...
 
static void tData (const char *fmt,...)
 Data trace output. More...
 
static void closeTrace ()
 Close trace file. More...
 
static bool isInitialized ()
 Returns the information if the trace is already initialized.
 

Static Protected Member Functions

static void trace (TraceLevel traceLevel, const char *fmt, va_list arg_ptr)
 File trace output preparation. More...
 
static void traceOutput (TraceLevel traceLevel, const char *sContent, int nModule=0, bool bFromUaStack=false)
 File trace output. More...
 

Detailed Description

A class used for trace outputs (error, information,...).

Member Enumeration Documentation

Definition of the TraceLevel Enumeration.

Enumerator
NoTrace 

Trace_Level: No Trace

Errors 

Trace_Level: Errors

Warning 

Trace_Level: Warning

Info 

Trace_Level: Info

InterfaceCall 

Trace_Level: Interface Call

CtorDtor 

Trace_Level: Ctor - Dtor

ProgramFlow 

Trace_Level: Program Flow

Data 

Trace_Level: Data

Member Function Documentation

long UaTrace::changeTrace ( TraceLevel  traceLevel,
unsigned int  maxTraceEntries,
unsigned int  NumBackupFiles,
const UaString traceFile 
)
static

Change the trace settings.

Parameters
traceLevelthe actual trace level.
maxTraceEntriesthe maximum number of trace entries.
NumBackupFilesthe number of all backup files.
traceFilethe file where the trace will be printed in.
Returns
the trace settings.
void UaTrace::closeTrace ( )
static

Close trace file.

UaTrace::TraceLevel UaTrace::getTraceLevel ( )
static

Get the trace level.

Returns
the trace level.
long UaTrace::initErrorTrace ( const UaString traceFile,
const UaString appName 
)
static

Initialize the trace.

Parameters
traceFilethe file where the trace will be printed in.
appNamethe application name.
Returns
the initialized error trace.
long UaTrace::initTrace ( TraceLevel  traceLevel,
unsigned int  maxTraceEntries,
unsigned int  NumBackupFiles,
const UaString traceFile,
const UaString appName 
)
static

Initialize the trace.

Parameters
traceLevelthe actual trace level.
maxTraceEntriesthe maximum of trace entries.
NumBackupFilesthe number of all backup files.
traceFilethe file where the trace will be printed out.
appNamethe application name.
Returns
the initialized trace.
void UaTrace::setErrorTraceHook ( UaTraceHook pErrorTraceHook)
static

Set a trace hook for all error, warning and info trace messages.

Parameters
pErrorTraceHookInterface pointer for the trace hook.
void UaTrace::setLocalTimeOutput ( bool  isLocal)
static

Set time output for trace to local time.

Parameters
isLocaltrue if local false if not.
void UaTrace::setPrintDateInTrace ( bool  printDateInTrace)
static

Set time output for trace to print also the date.

Parameters
printDateInTracetrue if print date in trace false if not.
long UaTrace::setProductVersion ( const UaString productVersion)
static

Get the trace level.

Returns
the trace level.
void UaTrace::setTraceHook ( UaTraceHook pTraceHook)
static

Set a trace hook for all trace messages passing the configured trace level.

Parameters
pTraceHookInterface pointer for the trace hook.
void UaTrace::tCtor ( const char *  fmt,
  ... 
)
static

Ctor and Dtor trace output.

Parameters
fmtthe message to be printed out
void UaTrace::tData ( const char *  fmt,
  ... 
)
static

Data trace output.

Parameters
fmtthe message to be printed out
void UaTrace::tError ( const char *  fmt,
  ... 
)
static

Error trace output.

Parameters
fmtthe message to be printed out
void UaTrace::tIfCall ( const char *  fmt,
  ... 
)
static

External interface call trace output.

Parameters
fmtthe message to be printed out
void UaTrace::tInfo ( const char *  fmt,
  ... 
)
static

Info trace output.

Parameters
fmtthe message to be printed out
void UaTrace::tInOut ( const char *  fmt,
  ... 
)
static

Program flow trace output.

Parameters
fmtthe message to be printed out
void UaTrace::trace ( TraceLevel  traceLevel,
const char *  fmt,
va_list  arg_ptr 
)
staticprotected

File trace output preparation.

Parameters
traceLevelthe actual trace level.
fmtthe message to be printed out
arg_ptra pointer to the arguments.
void UaTrace::traceOutput ( TraceLevel  traceLevel,
const char *  sContent,
int  nModule = 0,
bool  bFromUaStack = false 
)
staticprotected

File trace output.

Parameters
traceLevelthe actual trace level.
sContentthe message to be printed out
nModulethe module printing the message.
bFromUaStacka flag indicating if the message is from the stack.
void UaTrace::tWarning ( const char *  fmt,
  ... 
)
static

Warning trace output.

Parameters
fmtthe message to be printed out

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