My Project
TimeSpan Class Reference

the TimeSpan class. More...

#include <OSGeneral.h>

Inheritance diagram for TimeSpan:
TimeMeasurement

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

Constructor & Destructor Documentation

◆ TimeSpan()

TimeSpan::TimeSpan ( )

Default constructor.

Definition at line 1622 of file OSGeneral.cpp.

◆ ~TimeSpan()

TimeSpan::~TimeSpan ( )

Class destructor.

Definition at line 1628 of file OSGeneral.cpp.

Member Function Documentation

◆ IsEqual()

bool TimeSpan::IsEqual ( TimeSpan * that)

A function to check for the equality of two objects.

Definition at line 1635 of file OSGeneral.cpp.

◆ setRandom()

bool TimeSpan::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)

Definition at line 1683 of file OSGeneral.cpp.

◆ deepCopyFrom()

bool TimeSpan::deepCopyFrom ( TimeSpan * that)

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

Parameters
thatthe 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

◆ unit

std::string TimeSpan::unit

the unit in which time is measured

Definition at line 929 of file OSGeneral.h.

◆ value

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: