Public Member Functions | Public Attributes | List of all members
TimeSpan Class Reference

the TimeSpan class. More...

#include <OSGeneral.h>

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

Public Member Functions

 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 unit
 the unit in which time is measured More...
 
double value
 the number of units More...
 

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 924 of file OSGeneral.h.

Constructor & Destructor Documentation

TimeSpan::TimeSpan ( )

Default constructor.

Definition at line 1622 of file OSGeneral.cpp.

TimeSpan::~TimeSpan ( )

Class destructor.

Definition at line 1628 of file OSGeneral.cpp.

Member Function Documentation

bool TimeSpan::IsEqual ( TimeSpan that)

A function to check for the equality of two objects.

Definition at line 1635 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)

Definition at line 1683 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 1704 of file OSGeneral.cpp.

Member Data Documentation

std::string TimeSpan::unit

the unit in which time is measured

Definition at line 929 of file OSGeneral.h.

double TimeSpan::value

the number of units

Definition at line 932 of file OSGeneral.h.


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