StorageCapacity Class Reference
the StorageCapacity class. More...
#include <OSGeneral.h>
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.
- 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.
Definition at line 1352 of file OSGeneral.cpp.
| StorageCapacity::~StorageCapacity | ( | ) |
Class destructor.
Definition at line 1359 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 1366 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 1415 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 1437 of file OSGeneral.cpp.
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 files:
- /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSGeneral.h
- /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSGeneral.cpp
