OS  2.9.3
Public Member Functions | Public Attributes | List of all members
TimeMeasurement Class Reference

The TimeMeasurement Class. More...

#include <OSResult.h>

+ Inheritance diagram for TimeMeasurement:
+ Collaboration diagram for TimeMeasurement:

Public Member Functions

 TimeMeasurement ()
 Default constructor. More...
 
 ~TimeMeasurement ()
 Class destructor. More...
 
bool IsEqual (TimeMeasurement *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class. More...
 
- Public Member Functions inherited from TimeSpan
 TimeSpan ()
 Default constructor. More...
 
 ~TimeSpan ()
 Class destructor. More...
 
bool IsEqual (TimeSpan *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (TimeSpan *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

std::string type
 The type of timer used (cpuTime/elapsedTime/other) More...
 
std::string category
 The category of time (total/input/preprocessing/optimization/postprocessing/output/other) More...
 
std::string description
 Further description on the timer used. More...
 
- Public Attributes inherited from TimeSpan
std::string unit
 the unit in which time is measured More...
 
double value
 the number of units More...
 

Detailed Description

The TimeMeasurement Class.

Author
Horand Gassmann, Jun Ma, Kipp Martin
Remarks
A class that provides an individual time measurement as defined in the OSrL schema. Extends the class TimeSpan defined in OSGeneral.h by adding three elements type, category and description. This class supersedes the old class Time since version 2.3.

Definition at line 545 of file OSResult.h.

Constructor & Destructor Documentation

TimeMeasurement::TimeMeasurement ( )

Default constructor.

TimeMeasurement::~TimeMeasurement ( )

Class destructor.

Member Function Documentation

bool TimeMeasurement::IsEqual ( TimeMeasurement that)

A function to check for the equality of two objects.

bool TimeMeasurement::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Member Data Documentation

std::string TimeMeasurement::type

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

Definition at line 552 of file OSResult.h.

std::string TimeMeasurement::category

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

Definition at line 557 of file OSResult.h.

std::string TimeMeasurement::description

Further description on the timer used.

Definition at line 562 of file OSResult.h.


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