SST  14.1.0
StructuralSimulationToolkit
SST::TraceFunction Class Reference


Class to easily trace function enter and exit. More...

#include <output.h>

Public Member Functions

 TraceFunction (uint32_t line, const char *file, const char *func, bool print_sim_info=true, bool activate=true)
 
void output (const char *format,...) const
 Output the message with formatting as specified by the format parameter. More...
 

Detailed Description


Class to easily trace function enter and exit.

This class is for temporary use during debugging only and is not part of the SST Core stable API (i.e. the class can change at any time).

NOTE: Output for TraceFunction will only be turned on if the SST_TRACEFUNCTION_ACTIVATE envirnoment variable is set.

You can also control whether or not an "indent marker" will be used by setting SST_TRACEFUNCTION_INDENT_MARKER. If the environment variable is defined but empty, a | will be used. If the variable isn't empty, it will use the first character as the indent marker. This will look like:

static void class1::func1() enter function | static void class1::func2() enter function | static void class1::func2() exit function static void class1::func1() exit function static void class1::func1() enter function | static void class1::func2() enter function | static void class1::func2() exit function static void class1::func1() exit function

Member Function Documentation

◆ output()

void SST::TraceFunction::output ( const char *  format,
  ... 
) const

Output the message with formatting as specified by the format parameter.

Parameters
formatFormat string. All valid formats for printf are available.
...Arguments for format.

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