OtherOptionOrResultEnumeration Class Reference

#include <OSGeneral.h>

Inheritance diagram for OtherOptionOrResultEnumeration:

[legend]

Collaboration diagram for OtherOptionOrResultEnumeration:

[legend]

List of all members.

Public Member Functions
	OtherOptionOrResultEnumeration ()
	~OtherOptionOrResultEnumeration ()
	OtherOptionOrResultEnumeration (int n)
	alternate constructor
bool	IsEqual (OtherOptionOrResultEnumeration *that)
	A function to check for the equality of two objects.
bool	setRandom (double density, bool conformant, int iMin, int iMax)
	A function to make a random instance of this class.
bool	deepCopyFrom (OtherOptionOrResultEnumeration *that)
	A function to make a deep copy of an instance of this class.
bool	setOtherOptionOrResultEnumeration (std::string value, std::string description, int *i, int ni)
	Set the indices for a particular level in an enumeration.
std::string	getValue ()
	Get the value for a particular level in an enumeration.
std::string	getDescription ()
	Get the description for a particular level in an enumeration.
Public Attributes
std::string	value
std::string	description

---

Detailed Description

brief an integer vector data structure used in OSOption and OSResult

This class extends IntVector by adding two string-valued elements, value and description

Definition at line 549 of file OSGeneral.h.

---

Constructor & Destructor Documentation

OtherOptionOrResultEnumeration::OtherOptionOrResultEnumeration

(

)

Definition at line 591 of file OSGeneral.cpp.

OtherOptionOrResultEnumeration::~OtherOptionOrResultEnumeration

(

)

Definition at line 613 of file OSGeneral.cpp.

OtherOptionOrResultEnumeration::OtherOptionOrResultEnumeration

(

int

n

)

alternate constructor

Definition at line 602 of file OSGeneral.cpp.

---

Member Function Documentation

bool OtherOptionOrResultEnumeration::IsEqual

(

OtherOptionOrResultEnumeration *

that

)

A function to check for the equality of two objects.

Reimplemented from IntVector.

Definition at line 639 of file OSGeneral.cpp.

bool OtherOptionOrResultEnumeration::setRandom	(	double	density,
		bool	conformant,
		int	iMin,
		int	iMax
	)

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)
	iMin,:	lowest value (inclusive) that an entry in this vector can take
	iMax,:	greatest value (inclusive) that an entry in this vector can take

Reimplemented from IntVector.

Definition at line 686 of file OSGeneral.cpp.

bool OtherOptionOrResultEnumeration::deepCopyFrom

(

OtherOptionOrResultEnumeration *

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

Reimplemented from IntVector.

Definition at line 698 of file OSGeneral.cpp.

bool OtherOptionOrResultEnumeration::setOtherOptionOrResultEnumeration	(	std::string	value,
		std::string	description,
		int *	i,
		int	ni
	)

Set the indices for a particular level in an enumeration.

Parameters:

	value	represents the value of this enumeration member
	description	holds additional information about this value
	i	contains the array of indices
	ni	contains the number of elements in i

Definition at line 621 of file OSGeneral.cpp.

std::string OtherOptionOrResultEnumeration::getValue

(

)

Get the value for a particular level in an enumeration.

Definition at line 628 of file OSGeneral.cpp.

std::string OtherOptionOrResultEnumeration::getDescription

(

)

Get the description for a particular level in an enumeration.

Definition at line 633 of file OSGeneral.cpp.

---

Member Data Documentation

std::string OtherOptionOrResultEnumeration::value

Definition at line 552 of file OSGeneral.h.

std::string OtherOptionOrResultEnumeration::description

Definition at line 553 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