#include <OSOption.h>

Collaboration diagram for InitConstraintValues:

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

	~InitConstraintValues ()
	Class destructor. More...

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

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

bool	setCon (int numberOfCon, InitConValue **con, ENUM_COMBINE_ARRAYS disp)
	Alternative signature for this function. More...

bool	setCon (int numberOfCon, int idx, double value, std::string *name)
	Another alternative signature for this function. More...

bool	addCon (int idx, double value)
	A function to add a <con> element. More...

bool	addCon (int numberOfCon, InitConValue **con)
	Alternative signature for this function. More...

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

InitConValue **	con
	initial value for each constraint More...

Detailed Description

the InitConstraintValues 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 2822 of file OSOption.h.

Constructor & Destructor Documentation

InitConstraintValues::InitConstraintValues ( )

Default constructor.

Definition at line 1000 of file OSOption.cpp.

InitConstraintValues::~InitConstraintValues ( )

Class destructor.

Definition at line 1009 of file OSOption.cpp.

Member Function Documentation

bool InitConstraintValues::IsEqual ( InitConstraintValues * that )

A function to check for the equality of two objects.

Definition at line 11766 of file OSOption.cpp.

bool InitConstraintValues::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 13106 of file OSOption.cpp.

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

bool InitConstraintValues::setCon	(	int	numberOfCon,
		InitConValue **	con
	)

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

Parameters

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

Definition at line 6781 of file OSOption.cpp.

bool InitConstraintValues::setCon	(	int	numberOfCon,
		InitConValue **	con,
		ENUM_COMBINE_ARRAYS	disp
	)

Alternative signature for this function.

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

Parameters

numberOfVar,:	number of elements to be set
var,:	the array of elements that are to be set
disp,:	method of disposition if previous data exist
numberOfCon,:	number of <con> elements to be set
con,:	the array of <con> elements that are to be set
disp,:	method of disposition if previous data exist

Definition at line 6819 of file OSOption.cpp.

bool InitConstraintValues::setCon	(	int	numberOfCon,
		int *	idx,
		double *	value,
		std::string *	name
	)

Another alternative signature for this function.

Parameters

numberOfCon,:	number of <con> elements to be set
idx,:	the array of indices
value,:	the array of corresponding values
name,:	the array of constraint names

Definition at line 6864 of file OSOption.cpp.

bool InitConstraintValues::addCon	(	int	idx,
		double	value
	)

A function to add a <con> element.

Parameters

idx,:	the index of the constraint to be given an initial value
value,:	the initial value to be added
idx,:	the index of the constraint to be given an inital value
value,:	the initial value to be added

Definition at line 6897 of file OSOption.cpp.

bool InitConstraintValues::addCon	(	int	numberOfCon,
		InitConValue **	con
	)

Alternative signature for this function.

A function to add several <con> elements.

A function to add an array of <con> elements simultaneously

Parameters

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

Definition at line 6940 of file OSOption.cpp.

Member Data Documentation

int InitConstraintValues::numberOfCon

number of <con> children

Definition at line 2827 of file OSOption.h.

InitConValue** InitConstraintValues::con

initial value for each constraint

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