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.

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:
Gus Gassmann, Jun Ma, Kipp Martin
Remarks:
A data structure class that corresponds to an xml element in the OSgL schema.

Definition at line 658 of file OSGeneral.h.


Constructor & Destructor Documentation

StorageCapacity::StorageCapacity (  ) 

Default constructor.

Definition at line 1024 of file OSGeneral.cpp.

StorageCapacity::~StorageCapacity (  ) 

Class destructor.

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

References description, isEqual(), unit, and value.

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 1079 of file OSGeneral.cpp.

References description, OSRand(), unit, and value.

Referenced by JobResult::setRandom(), SystemResult::setRandom(), and SystemOption::setRandom().


Member Data Documentation

std::string StorageCapacity::unit

the unit in which storage capacity is measured

Definition at line 663 of file OSGeneral.h.

Referenced by OSResult::getAvailableDiskSpaceUnit(), OSResult::getAvailableMemoryUnit(), OSOption::getMinDiskSpaceUnit(), OSOption::getMinMemoryUnit(), OSResult::getUsedDiskSpaceUnit(), OSResult::getUsedMemoryUnit(), IsEqual(), OSResult::setAvailableDiskSpaceUnit(), OSResult::setAvailableMemoryUnit(), OSOption::setMinDiskSpace(), OSOption::setMinDiskSpaceUnit(), OSOption::setMinMemorySize(), OSOption::setMinMemoryUnit(), setRandom(), OSResult::setUsedDiskSpaceUnit(), OSResult::setUsedMemoryUnit(), OSoLWriter::writeOSoL(), and OSrLWriter::writeOSrL().

std::string StorageCapacity::description

additional description about the storage

Definition at line 666 of file OSGeneral.h.

Referenced by OSResult::getAvailableDiskSpaceDescription(), OSResult::getAvailableMemoryDescription(), OSOption::getMinDiskSpaceDescription(), OSOption::getMinMemoryDescription(), OSResult::getUsedDiskSpaceDescription(), OSResult::getUsedMemoryDescription(), IsEqual(), OSResult::setAvailableDiskSpaceDescription(), OSResult::setAvailableMemoryDescription(), OSOption::setMinDiskSpace(), OSOption::setMinMemorySize(), setRandom(), OSResult::setUsedDiskSpaceDescription(), OSResult::setUsedMemoryDescription(), OSoLWriter::writeOSoL(), and OSrLWriter::writeOSrL().

double StorageCapacity::value

the number of units of storage capacity

Definition at line 669 of file OSGeneral.h.

Referenced by OSResult::getAvailableDiskSpaceValue(), OSResult::getAvailableMemoryValue(), OSOption::getMinDiskSpace(), OSOption::getMinMemorySize(), OSResult::getUsedDiskSpaceValue(), OSResult::getUsedMemoryValue(), IsEqual(), OSResult::setAvailableDiskSpaceValue(), OSResult::setAvailableMemoryValue(), OSOption::setMinDiskSpace(), OSOption::setMinMemorySize(), setRandom(), OSResult::setUsedDiskSpaceValue(), OSResult::setUsedMemoryValue(), OSoLWriter::writeOSoL(), and OSrLWriter::writeOSrL().


The documentation for this class was generated from the following files:
Generated on Wed Nov 30 03:12:18 2011 by  doxygen 1.4.7