ldas-tools-al 2.6.7
Loading...
Searching...
No Matches
LDASTools::AL::Profile Class Reference

Provide profiling information. More...

#include <Profile.hh>

Collaboration diagram for LDASTools::AL::Profile:

Public Member Functions

 Profile (const char *Header)
 Constructor.
 
std::string operator() (const char *Filename, size_t Line, const char *Message="")
 Output profiling information.
 
 Profile (const char *Header)
 Constructor.
 
std::string operator() (const char *Filename, size_t Line, const char *Message="")
 Output profiling information.
 

Private Attributes

const char * m_header
 
GPSTime m_start
 
GPSTime m_previous
 
GPSTime m_now
 

Detailed Description

Provide profiling information.

This class is intended to be used for debugging purposes. It records the the time the instance was instantiated and then reports the differnce between the current time and the instantiated time so a developer can evaluate the speed of a routine.

Constructor & Destructor Documentation

◆ Profile() [1/2]

LDASTools::AL::Profile::Profile ( const char * Header)
inline

Constructor.

Parameters
HeaderThis is a message which is to appear at the beginning of each line of output. It most commonly will be the fully qualified name of the function or method that was invoked.

◆ Profile() [2/2]

LDASTools::AL::Profile::Profile ( const char * Header)

Constructor.

Parameters
HeaderThis is a message which is to appear at the beginning of each line of output. It most commonly will be the fully qualified name of the function or method that was invoked.

Member Function Documentation

◆ operator()() [1/2]

std::string LDASTools::AL::Profile::operator() ( const char * Filename,
size_t Line,
const char * Message = "" )
inline

Output profiling information.

Parameters
FilenameThe name of the file being profiled.
LineThe line number inside the file being profiled.
MessageText to appear immediately following the Header given at instantiation.
Returns
The profiling data formatted as a string.

◆ operator()() [2/2]

std::string LDASTools::AL::Profile::operator() ( const char * Filename,
size_t Line,
const char * Message = "" )

Output profiling information.

Parameters
FilenameThe name of the file being profiled.
LineThe line number inside the file being profiled.
MessageText to appear immediately following the Header given at instantiation.
Returns
The profiling data formatted as a string.

Member Data Documentation

◆ m_header

const char * LDASTools::AL::Profile::m_header
private

◆ m_now

GPSTime LDASTools::AL::Profile::m_now
private

◆ m_previous

GPSTime LDASTools::AL::Profile::m_previous
private

◆ m_start

GPSTime LDASTools::AL::Profile::m_start
private

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