Public Member Functions | List of all members

#include <tjlog.h>

Inheritance diagram for Log< C >:
Inheritance graph
[legend]

Public Member Functions

 Log (const char *objectLabel, const char *functionName, logPriority level=verboseDebug)
 
 Log (const Labeled *labeledObject, const char *functionName, logPriority level=verboseDebug)
 
 ~Log ()
 

Additional Inherited Members

- Static Public Member Functions inherited from LogBase
static void set_log_level (const char *compname, logPriority level)
 
static void set_uniform_log_level (logPriority level)
 
static bool set_log_levels (int argc, char *argv[], bool trigger_error=true)
 
static STD_string get_usage ()
 
static const char * get_levels ()
 
static void set_levels (const char *str)
 
static void set_log_output_function (tracefunction func)
 

Detailed Description

template<class C>
class Log< C >

Logging class to store logging information of the current scope (object, function, ...). The template parameter specifies the component in which logging is placed, e.g. Log<Seq> for tracing sequence code.

Definition at line 218 of file tjlog.h.

Constructor & Destructor Documentation

§ Log() [1/2]

template<class C >
Log< C >::Log ( const char *  objectLabel,
const char *  functionName,
logPriority  level = verboseDebug 
)

Constructs a logging stream for object 'objectLabel' and function 'functionName'. Both strings will precede the actual message in the log. The third argument specifies a uniform logging priority for the constructor and destructor. This constructor will automatically generate a START tag in the log for the function it is used in.

Definition at line 26 of file tjlog_code.h.

§ Log() [2/2]

template<class C >
Log< C >::Log ( const Labeled labeledObject,
const char *  functionName,
logPriority  level = verboseDebug 
)

Constructs a logging stream for labeled object 'labeledObject' and function 'functionName'. Both the label and the function name will precede the actual message in the log. The third argument specifies a uniform logging priority for the constructor and destructor. This constructor will automatically generate a START tag in the log for the function it is used in.

Definition at line 34 of file tjlog_code.h.

§ ~Log()

template<class C >
Log< C >::~Log ( )

This destructor will automatically generate an END tag in the log for the function its object is used in.

Definition at line 42 of file tjlog_code.h.


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