SolverOptions Class Reference

the SolverOptions class. More...

#include <OSOption.h>

Collaboration diagram for SolverOptions:

Public Member Functions
	SolverOptions ()
	Default constructor. More...
	~SolverOptions ()
	Class destructor. More...
bool	IsEqual (SolverOptions *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 (SolverOptions *that)
	A function to make a deep copy of an instance of this class. More...
bool	setSolverOptions (int numberOfOptions, SolverOption **solverOption)
	A function to set an array of solver options. More...
bool	addSolverOption (std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
	A function to add a solver option. More...

Public Attributes
int	numberOfSolverOptions
	the number of solver options More...
SolverOption **	solverOption
	the list of solver options More...

Detailed Description

the SolverOptions 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 3418 of file OSOption.h.

Constructor & Destructor Documentation

SolverOptions::SolverOptions

(

)

Default constructor.

Definition at line 1204 of file OSOption.cpp.

SolverOptions::~SolverOptions

(

)

Class destructor.

Definition at line 1213 of file OSOption.cpp.

Member Function Documentation

bool SolverOptions::IsEqual

(

SolverOptions *

that

)

A function to check for the equality of two objects.

Definition at line 12080 of file OSOption.cpp.

bool SolverOptions::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 13249 of file OSOption.cpp.

bool SolverOptions::deepCopyFrom

(

SolverOptions *

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 14321 of file OSOption.cpp.

bool SolverOptions::setSolverOptions	(	int	numberOfOptions,
		SolverOption **	solverOption
	)

A function to set an array of solver options.

Parameters

numberOfOptions,:	number of solver options to be set
solverOption,:	the array of solver options that are to be set

Definition at line 7424 of file OSOption.cpp.

bool SolverOptions::addSolverOption	(	std::string	name,
		std::string	value,
		std::string	solver,
		std::string	category,
		std::string	type,
		std::string	description
	)

A function to add a solver option.

Parameters

name,:	the name of the solver option (required)
value,:	a value associated with the option (optional)
solver,:	the solver to which the option applies (optional)
category,:	the category (and subcategories) of the option (optional)
type,:	the type of the option (optional)
description,:	a description associated with the option (optional)

Definition at line 7480 of file OSOption.cpp.

Member Data Documentation

int SolverOptions::numberOfSolverOptions

the number of solver options

Definition at line 3423 of file OSOption.h.

SolverOption** SolverOptions::solverOption

the list of solver options

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