Time Class Reference

The Time Class. More...

#include <OSResult.h>

Collaboration diagram for Time:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Time ()
 Default constructor.
 ~Time ()
 Class destructor.
bool IsEqual (Time *that)
 A function to check for the equality of two objects.
 Time ()
 Default constructor.
 ~Time ()
 Class destructor.

Public Attributes

std::string type
 The type of timer used (cpuTime/elapsedTime/other).
std::string category
 The category of time (total/input/preprocessing/optimization/postprocessing/output/other).
std::string unit
 The unit of time (tick/millisecond/second/minute/hour/day/week/month/year).
std::string description
 Further description on the timer used.
double value
 The time measurement.

Detailed Description

The Time Class.

Author:
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 03/14/2004
Since:
OS 1.0
Remarks:
A class that provides an array of individual time measurements that are defined in the OSrL schema.

Definition at line 582 of file OSResult.h.


Constructor & Destructor Documentation

Time::Time (  ) 

Default constructor.

Definition at line 298 of file OSResult.cpp.

Time::~Time (  ) 

Class destructor.

Definition at line 311 of file OSResult.cpp.

Time::Time (  ) 

Default constructor.

Time::~Time (  ) 

Class destructor.


Member Function Documentation

bool Time::IsEqual ( Time that  ) 

A function to check for the equality of two objects.

Definition at line 5198 of file OSResult.cpp.

References category, description, type, unit, and value.


Member Data Documentation

std::string Time::type

The type of timer used (cpuTime/elapsedTime/other).

Definition at line 588 of file OSResult.h.

Referenced by OSResult::addTimingInformation(), OSResult::getTimingInfoType(), IsEqual(), OSResult::setTimingInformation(), and OSrLWriter::writeOSrL().

std::string Time::category

The category of time (total/input/preprocessing/optimization/postprocessing/output/other).

Definition at line 593 of file OSResult.h.

Referenced by OSResult::addTimingInformation(), OSResult::getTimingInfoCategory(), IsEqual(), OSResult::setTimingInformation(), and OSrLWriter::writeOSrL().

std::string Time::unit

The unit of time (tick/millisecond/second/minute/hour/day/week/month/year).

Definition at line 598 of file OSResult.h.

Referenced by OSResult::addTimingInformation(), OSResult::getTimingInfoUnit(), IsEqual(), OSResult::setTimingInformation(), and OSrLWriter::writeOSrL().

std::string Time::description

Further description on the timer used.

Definition at line 603 of file OSResult.h.

Referenced by OSResult::addTimingInformation(), OSResult::getTimingInfoDescription(), IsEqual(), OSResult::setTimingInformation(), and OSrLWriter::writeOSrL().

double Time::value

The time measurement.

Definition at line 608 of file OSResult.h.

Referenced by OSResult::addTimingInformation(), OSResult::getTimeValue(), OSResult::getTimingInfoValue(), IsEqual(), OSResult::setTimingInformation(), and OSrLWriter::writeOSrL().


The documentation for this class was generated from the following files:
Generated on Fri Jan 7 03:27:22 2011 by  doxygen 1.4.7