TimeSpan Class Reference

the TimeSpan class. More...

#include <OSGeneral.h>

Inheritance diagram for TimeSpan:
Inheritance graph
[legend]
Collaboration diagram for TimeSpan:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

std::string unit
 the unit in which time is measured
double value
 the number of units

Detailed Description

the TimeSpan class.

Author:
Horand Gassmann, Jun Ma, Kipp Martin
Remarks:
A data structure class that corresponds to an xml element in the OSgL schema.

Definition at line 878 of file OSGeneral.h.


Constructor & Destructor Documentation

TimeSpan::TimeSpan (  ) 

Default constructor.

Definition at line 1583 of file OSGeneral.cpp.

TimeSpan::~TimeSpan (  ) 

Class destructor.

Definition at line 1589 of file OSGeneral.cpp.


Member Function Documentation

bool TimeSpan::IsEqual ( TimeSpan that  ) 

A function to check for the equality of two objects.

Reimplemented in TimeMeasurement.

Definition at line 1596 of file OSGeneral.cpp.

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

A function to make a random instance of this class.

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

Reimplemented in TimeMeasurement.

Definition at line 1644 of file OSGeneral.cpp.

bool TimeSpan::deepCopyFrom ( TimeSpan that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Definition at line 1664 of file OSGeneral.cpp.


Member Data Documentation

std::string TimeSpan::unit

the unit in which time is measured

Definition at line 883 of file OSGeneral.h.

the number of units

Definition at line 886 of file OSGeneral.h.


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

Generated on 24 Jul 2013 by  doxygen 1.6.1