TraceAuto Class Reference

A class which records a begin event when it is constructed, and a matching end event when it is destructed. More...

Public Member Functions

 TraceAuto (const char *funcName, const char *prettyFuncName, const std::string &name)
 Constructor taking function name, pretty function name and a scope name. More...
 
 TraceAuto (const TfToken &key)
 Constructor taking a TfToken key. More...
 
 TraceAuto (const std::string &key)
 Constructor taking a string key. More...
 
 TraceAuto (const TraceAuto &)=delete
 
TraceAutooperator= (const TraceAuto &)=delete
 
 TraceAuto (TraceAuto &&)=delete
 
TraceAutooperator= (TraceAuto &&)=delete
 
 ~TraceAuto ()
 Destructor. More...
 

Detailed Description

A class which records a begin event when it is constructed, and a matching end event when it is destructed.

It is intended to help ensure begin-end pairing correctness when the begin-end pairing can be expressed by automatic variable lifetime.

The TRACE_FUNCTION() macro may be even more convenient in some circumstances.

Definition at line 256 of file trace.h.

Constructor & Destructor Documentation

◆ TraceAuto() [1/3]

TraceAuto ( const char *  funcName,
const char *  prettyFuncName,
const std::string &  name 
)
inline

Constructor taking function name, pretty function name and a scope name.

Definition at line 259 of file trace.h.

◆ TraceAuto() [2/3]

TraceAuto ( const TfToken key)
inlineexplicit

Constructor taking a TfToken key.

Definition at line 270 of file trace.h.

◆ TraceAuto() [3/3]

TraceAuto ( const std::string &  key)
inlineexplicit

Constructor taking a string key.

Definition at line 280 of file trace.h.

◆ ~TraceAuto()

~TraceAuto ( )
inline

Destructor.

Definition at line 295 of file trace.h.


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