Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Threading::ScopedTimer Class Reference

Used to time from this objects creation to its destruction. More...

#include <logtools.h>

Public Member Functions

 ScopedTimer (std::ostream &LogSink=std::cout, String ScopeToMeasure="UnknownScope", String ScopeFile=String(), Whole CurrentLine=0)
 In a ScopedTimerBegin xml element this logs every parameter and the current timestamp. More...
 
 ~ScopedTimer ()
 Destructor, logs duration and current timestamp in ScopedTimerEnd xml element.
 

Detailed Description

Used to time from this objects creation to its destruction.

Definition at line 75 of file logtools.h.

Constructor & Destructor Documentation

Mezzanine::Threading::ScopedTimer::ScopedTimer ( std::ostream &  LogSink = std::cout,
String  ScopeToMeasure = "UnknownScope",
String  ScopeFile = String(),
Whole  CurrentLine = 0 
)

In a ScopedTimerBegin xml element this logs every parameter and the current timestamp.

Parameters
LogSinkThe target to send log messages to.
ScopeToMeasureThe name of the current function or a user provided name.
ScopeFileDefaults to an empty string, should be set to FILE or similar.
CurrentLineDefaults to 0, should be set to LINE or similar.

Definition at line 53 of file logtools.cpp.


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