Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions
MoniTool_Timer Class Reference

Provides convenient service on global timers
accessed by string name, mostly aimed for debugging purposes

As an instance, envelopes the OSD_Timer to have it as Handle

As a tool, supports static dictionary of timers
and provides static methods to easily access them

#include <MoniTool_Timer.hxx>

Inheritance diagram for MoniTool_Timer:
Inheritance graph
[legend]

Public Member Functions

 MoniTool_Timer ()
 Create timer in empty state

const OSD_TimerTimer () const
OSD_TimerTimer ()
 Return reference to embedded OSD_Timer

void Start ()
void Stop ()
void Reset ()
 Start, Stop and reset the timer
In addition to doing that to embedded OSD_Timer,
manage also counter of hits

Standard_Integer Count () const
 Return value of hits counter (count of Start/Stop pairs)

Standard_Integer IsRunning () const
 Returns value of nesting counter

Standard_Real CPU ()
 Return value of CPU time minus accumulated amendment

Standard_Real Amend () const
 Return value of accumulated amendment on CPU time

void Dump (Standard_OStream &ostr)
 Dumps current state of a timer shortly (one-line output)

Static Public Member Functions

static Handle_MoniTool_Timer Timer (const Standard_CString name)
 Returns a timer from a dictionary by its name
If timer not existed, creates a new one

static void Start (const Standard_CString name)
static void Stop (const Standard_CString name)
 Inline methods to conveniently start/stop timer by name
Shortcut to Timer(name)->Start/Stop()

static MoniTool_DataMapOfTimerDictionary ()
 Returns map of timers

static void ClearTimers ()
 Clears map of timers

static void DumpTimers (Standard_OStream &ostr)
 Dumps contents of the whole dictionary

static void ComputeAmendments ()
 Computes and remembers amendments for times to
access, start, and stop of timer, and estimates
second-order error measured by 10 nested timers

static void GetAmendments (Standard_Real &Access, Standard_Real &Internal, Standard_Real &External, Standard_Real &Error10)
 The computed amendmens are returned (for information only)


Constructor & Destructor Documentation

MoniTool_Timer::MoniTool_Timer ( )

Member Function Documentation

Standard_Real MoniTool_Timer::Amend ( ) const
static void MoniTool_Timer::ClearTimers ( ) [static]
static void MoniTool_Timer::ComputeAmendments ( ) [static]
Standard_Integer MoniTool_Timer::Count ( ) const
Standard_Real MoniTool_Timer::CPU ( )
static MoniTool_DataMapOfTimer& MoniTool_Timer::Dictionary ( ) [static]
void MoniTool_Timer::Dump ( Standard_OStream ostr)
static void MoniTool_Timer::DumpTimers ( Standard_OStream ostr) [static]
static void MoniTool_Timer::GetAmendments ( Standard_Real Access,
Standard_Real Internal,
Standard_Real External,
Standard_Real Error10 
) [static]
Standard_Integer MoniTool_Timer::IsRunning ( ) const
void MoniTool_Timer::Reset ( )
void MoniTool_Timer::Start ( )
static void MoniTool_Timer::Start ( const Standard_CString  name) [static]
static void MoniTool_Timer::Stop ( const Standard_CString  name) [static]
void MoniTool_Timer::Stop ( )
OSD_Timer& MoniTool_Timer::Timer ( )
static Handle_MoniTool_Timer MoniTool_Timer::Timer ( const Standard_CString  name) [static]
const OSD_Timer& MoniTool_Timer::Timer ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines