TimedTask Class Reference

#include <IpTimedTask.hpp>

List of all members.


Detailed Description

This class is used to collect timing information for a particular task.


Public Member Functions

void Reset ()
 Method for resetting time to zero.
void Start ()
 Method that is called before execution of the task.
void End ()
 Method that is called after execution of the task.
void EndIfStarted ()
 Method that is called after execution of the task for which timing might have been started.
Number TotalTime () const
 Method returning total time spend for task so far.
Constructors/Destructors
 TimedTask ()
 Default constructor.
 ~TimedTask ()
 Default destructor.

Static Public Member Functions

static Number CpuTime ()
 method determining CPU executed since start of program


Constructor & Destructor Documentation

TimedTask (  )  [inline]

Default constructor.

~TimedTask (  )  [inline]

Default destructor.


Member Function Documentation

void Reset (  )  [inline]

Method for resetting time to zero.

Referenced by TimingStatistics::ResetTimes().

void Start (  )  [inline]

void End (  )  [inline]

void EndIfStarted (  )  [inline]

Method that is called after execution of the task for which timing might have been started.

This only updates the timing if the timing has indeed been conducted. This is useful to stop timing after catching exceptions.

References TimedTask::CpuTime(), and DBG_ASSERT.

Referenced by IpoptAlgorithm::Optimize().

Number TotalTime (  )  const [inline]

static Number CpuTime (  )  [inline, static]

method determining CPU executed since start of program

Referenced by TimedTask::End(), TimedTask::EndIfStarted(), and TimedTask::Start().


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

Generated on Fri Sep 26 07:44:27 2008 for SimTKcore by  doxygen 1.5.6