ifw-ccf  1.0.0
Public Member Functions | Static Public Attributes | List of all members
CCF_TRACE_CLASS Class Reference

Class used to generate TRACE logs. More...

#include <base.hpp>

Public Member Functions

 CCF_TRACE_CLASS (const std::string &location, const std::string &scope="")
 
 ~CCF_TRACE_CLASS ()
 Destructor generating the scope exit trace log. More...
 

Static Public Attributes

static int8_t s_nesting_level = -2
 
static std::string s_padding_chars
 

Detailed Description

Class used to generate TRACE logs.

The trace class is used to automatically log a scope entry and exit trace log. When entering the scope, an enter log is generated in the constructor. When exiting the scope, the trace class destructor generated a scope leaving log, including the time spent in the scope.

Constructor & Destructor Documentation

◆ CCF_TRACE_CLASS()

CCF_TRACE_CLASS::CCF_TRACE_CLASS ( const std::string &  location,
const std::string &  scope = "" 
)
inline

Constructor registering the location and optional scope description (user defined). It generate the scope entering log entry.

◆ ~CCF_TRACE_CLASS()

CCF_TRACE_CLASS::~CCF_TRACE_CLASS ( )
inline

Destructor generating the scope exit trace log.

Member Data Documentation

◆ s_nesting_level

int8_t CCF_TRACE_CLASS::s_nesting_level = -2
static

◆ s_padding_chars

std::string CCF_TRACE_CLASS::s_padding_chars
static

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