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

the OtherOptions class. More...

#include <OSOption.h>

+ Collaboration diagram for OtherOptions:

Public Member Functions

 OtherOptions ()
 Default constructor. More...
 
 ~OtherOptions ()
 Class destructor. More...
 
bool IsEqual (OtherOptions *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 (OtherOptions *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setOther (int numberOfOptions, OtherOption **other)
 A function to set an array of <other> elements. More...
 
bool addOther (std::string name, std::string value, std::string description)
 A function to add an <other> element. More...
 

Public Attributes

int numberOfOtherOptions
 the number of other options More...
 
OtherOption ** other
 the list of other options More...
 

Detailed Description

the OtherOptions class.

Author
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version
1.0, 21/07/2008
Since
OS 1.1
Remarks
A data structure class that corresponds to the OtherOptions element in the OSoL schema.

Definition at line 211 of file OSOption.h.

Constructor & Destructor Documentation

OtherOptions::OtherOptions ( )

Default constructor.

OtherOptions::~OtherOptions ( )

Class destructor.

Member Function Documentation

bool OtherOptions::IsEqual ( OtherOptions that)

A function to check for the equality of two objects.

bool OtherOptions::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 OtherOptions::deepCopyFrom ( OtherOptions 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
bool OtherOptions::setOther ( int  numberOfOptions,
OtherOption **  other 
)

A function to set an array of <other> elements.

Parameters
numberOfOptionsnumber of <other> elements to be set
otherthe array of <other> elements that are to be set
bool OtherOptions::addOther ( std::string  name,
std::string  value,
std::string  description 
)

A function to add an <other> element.

Parameters
namethe name of the <other> element to be added (required)
valuethe value of the <other> element to be added (optional)
descriptiona description of the <other> element (optional)

Member Data Documentation

int OtherOptions::numberOfOtherOptions

the number of other options

Definition at line 216 of file OSOption.h.

OtherOption** OtherOptions::other

the list of other options

Definition at line 219 of file OSOption.h.


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