Sierra Toolkit Version of the Day
stk::diag::Trace Class Reference

Class Trace serves as a sentry for entering routines. Creating a trace object prints the specified member function name to the specfied diag_writer and pushes the diag_writer depth. On destruction, it prints the member function name again and pops the depth. More...

#include <Trace.hpp>

Inheritance diagram for stk::diag::Trace:
Collaboration diagram for stk::diag::Trace:

List of all members.

Classes

struct  TraceList
 Typedef TraceList declares the trace list data type. More...

Public Types

enum  { IN_TRACE_LIST = 0x01 }
 Enumeration to describe the trace back flags. More...
typedef Writer &(* ExtraFuncPtr )(Writer &)
 Typedef ExtraFuncPtr declares the extra function pointer signature.

Public Member Functions

 Trace (Writer &dout, const char *function_name, int print_mask=LOG_TRACE, bool do_trace=true)
 Creates a new Trace instance, resulting in the printing of the member function name and pushing the depth.
 ~Trace ()
 Destroys a Trace instance, resulting in the printing of the member function name and popping the diag_writer depth.
Writerverbose_print (Writer &dout) const
 Member function dump writes the trace to the specified Writer.

Static Public Member Functions

static ExtraFuncPtr setExtra (ExtraFuncPtr extra)
 Member function setExtra sets the extra function which is called during each trace construction and destrution. (Not implemented)
static void addTraceFunction (const std::string &function_prefix)
 Member function addTraceFunction adds a function prefix to the list of function prefixes search to enable tracing.
static void clearTraceFunctions ()
 Member function clearTraceFunctions removes all function prefixes from the function signature prefix list.

Detailed Description

Class Trace serves as a sentry for entering routines. Creating a trace object prints the specified member function name to the specfied diag_writer and pushes the diag_writer depth. On destruction, it prints the member function name again and pops the depth.

A tracing depth feature has been incorporated into the Writer which enables diagnostic output only when tracing is activated using a specific

DiagTracingDetail

Definition at line 351 of file stk_util/stk_util/diag/Trace.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines