the OtherConstraintOption class. More...

#include <OSOption.h>

Collaboration diagram for OtherConstraintOption:

Public Member Functions
	OtherConstraintOption ()
	Default constructor. More...

	~OtherConstraintOption ()
	Class destructor. More...

bool	IsEqual (OtherConstraintOption *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 (OtherConstraintOption *that)
	A function to make a deep copy of an instance of this class. More...

bool	setCon (int numberOfCon, OtherConOption **con)
	A function to set an array of <con> elements. More...

bool	addCon (int idx, std::string value, std::string lbValue, std::string ubValue)
	A function to add a <con> element. More...

Public Attributes
int	numberOfCon
	number of <con> children More...

int	numberOfEnumerations
	number of <enumeration> child elements More...

std::string	name
	name of the option More...

std::string	value
	value of the option More...

std::string	solver
	name of the solver to which this option applies More...

std::string	category
	name of the category into which this option falls More...

std::string	type
	type of the option value (integer, double, boolean, string) More...

std::string	description
	description of the option More...

OtherConOption **	con
	array of option values More...

std::string	conType
	type of the values in the con array More...

OtherOptionOrResultEnumeration **	enumeration

std::string	enumType
	type of the values in the enumeration array More...

Detailed Description

the OtherConstraintOption 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 an xml element in the OSoL schema.

Definition at line 3156 of file OSOption.h.

Constructor & Destructor Documentation

OtherConstraintOption::OtherConstraintOption ( )

Default constructor.

Definition at line 1095 of file OSOption.cpp.

OtherConstraintOption::~OtherConstraintOption ( )

Class destructor.

Definition at line 1114 of file OSOption.cpp.

Member Function Documentation

bool OtherConstraintOption::IsEqual ( OtherConstraintOption * that )

A function to check for the equality of two objects.

Definition at line 11959 of file OSOption.cpp.

bool OtherConstraintOption::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 13185 of file OSOption.cpp.

bool OtherConstraintOption::deepCopyFrom ( OtherConstraintOption * 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 14259 of file OSOption.cpp.

bool OtherConstraintOption::setCon	(	int	numberOfCon,
		OtherConOption **	con
	)

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

Parameters

numberOfCon,:	number of <con> elements to be set
obj,:	the array of <con> elements that are to be set

Definition at line 7186 of file OSOption.cpp.

bool OtherConstraintOption::addCon	(	int	idx,
		std::string	value,
		std::string	lbValue,
		std::string	ubValue
	)

A function to add a <con> element.

Parameters

idx,:	the index of the constraint
value,:	the value associated with this constraint
lbValue,:	a lower bound associated with this constraint
ubValue,:	an upper bound associated with this constraint

Definition at line 7225 of file OSOption.cpp.

Member Data Documentation

int OtherConstraintOption::numberOfCon

number of <con> children

Definition at line 3161 of file OSOption.h.

int OtherConstraintOption::numberOfEnumerations

number of <enumeration> child elements

Definition at line 3164 of file OSOption.h.

std::string OtherConstraintOption::name

name of the option

Definition at line 3167 of file OSOption.h.

std::string OtherConstraintOption::value

value of the option

Definition at line 3170 of file OSOption.h.

std::string OtherConstraintOption::solver

name of the solver to which this option applies

Definition at line 3173 of file OSOption.h.

std::string OtherConstraintOption::category

name of the category into which this option falls

Definition at line 3176 of file OSOption.h.

std::string OtherConstraintOption::type

type of the option value (integer, double, boolean, string)

Definition at line 3179 of file OSOption.h.

std::string OtherConstraintOption::description

description of the option

Definition at line 3182 of file OSOption.h.

OtherConOption** OtherConstraintOption::con

array of option values

Definition at line 3185 of file OSOption.h.

std::string OtherConstraintOption::conType

type of the values in the con array

Definition at line 3188 of file OSOption.h.

OtherOptionOrResultEnumeration** OtherConstraintOption::enumeration

Definition at line 3194 of file OSOption.h.

std::string OtherConstraintOption::enumType

type of the values in the enumeration array

Definition at line 3197 of file OSOption.h.

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

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation