OS  2.10.1
Public Member Functions | Public Attributes | List of all members
StorageCapacity Class Reference

the StorageCapacity class. More...

#include <OSGeneral.h>

+ Collaboration diagram for StorageCapacity:

Public Member Functions

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

Public Attributes

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

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

Constructor & Destructor Documentation

StorageCapacity::StorageCapacity ( )

Default constructor.

StorageCapacity::~StorageCapacity ( )

Class destructor.

Member Function Documentation

bool StorageCapacity::IsEqual ( StorageCapacity that)

A function to check for the equality of two objects.

bool StorageCapacity::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)
bool StorageCapacity::deepCopyFrom ( StorageCapacity 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

Member Data Documentation

std::string StorageCapacity::unit

the unit in which storage capacity is measured

Definition at line 759 of file OSGeneral.h.

std::string StorageCapacity::description

additional description about the storage

Definition at line 762 of file OSGeneral.h.

double StorageCapacity::value

the number of units of storage capacity

Definition at line 765 of file OSGeneral.h.


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