StorageCapacity Class Reference

the StorageCapacity class. More...

#include <OSGeneral.h>

Collaboration diagram for StorageCapacity:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 StorageCapacity ()
 Default constructor.
 ~StorageCapacity ()
 Class destructor.
bool IsEqual (StorageCapacity *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 (StorageCapacity *that)
 A function to make a deep copy of an instance of this class.

Public Attributes

std::string unit
 the unit in which storage capacity is measured
std::string description
 additional description about the storage
double value
 the number of units of storage capacity

Detailed Description

the StorageCapacity 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 709 of file OSGeneral.h.


Constructor & Destructor Documentation

StorageCapacity::StorageCapacity (  ) 

Default constructor.

Definition at line 1314 of file OSGeneral.cpp.

StorageCapacity::~StorageCapacity (  ) 

Class destructor.

Definition at line 1321 of file OSGeneral.cpp.


Member Function Documentation

bool StorageCapacity::IsEqual ( StorageCapacity that  ) 

A function to check for the equality of two objects.

Definition at line 1328 of file OSGeneral.cpp.

bool StorageCapacity::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 1377 of file OSGeneral.cpp.

bool StorageCapacity::deepCopyFrom ( StorageCapacity 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 1398 of file OSGeneral.cpp.


Member Data Documentation

std::string StorageCapacity::unit

the unit in which storage capacity is measured

Definition at line 714 of file OSGeneral.h.

additional description about the storage

Definition at line 717 of file OSGeneral.h.

the number of units of storage capacity

Definition at line 720 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