My Project
OtherOptions Class Reference

the OtherOptions class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

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

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::OtherOptions ( )

Default constructor.

Definition at line 84 of file OSOption.cpp.

◆ ~OtherOptions()

OtherOptions::~OtherOptions ( )

Class destructor.

Definition at line 93 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool OtherOptions::IsEqual ( OtherOptions * that)

A function to check for the equality of two objects.

Definition at line 10070 of file OSOption.cpp.

◆ setRandom()

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)

Definition at line 12482 of file OSOption.cpp.

◆ deepCopyFrom()

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

Definition at line 13597 of file OSOption.cpp.

◆ setOther()

bool OtherOptions::setOther ( int numberOfOptions,
OtherOption ** other )

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

setOther() set an array of <other> elements in <general>, <system>, <service> and <job>

Parameters
numberOfOptionsnumber of <other> elements to be set
otherthe array of <other> elements that are to be set

set() options

Definition at line 4599 of file OSOption.cpp.

◆ addOther()

bool OtherOptions::addOther ( std::string name,
std::string value,
std::string description )

A function to add an <other> element.

addOther() used to add an <other> element in <general>, <system>, <service>, <job> etc.

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)

Definition at line 4633 of file OSOption.cpp.

Member Data Documentation

◆ numberOfOtherOptions

int OtherOptions::numberOfOtherOptions

the number of other options

Definition at line 216 of file OSOption.h.

◆ other

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 files: