SolverOptions Class Reference

the SolverOptions class. More...

#include <OSOption.h>

Collaboration diagram for SolverOptions:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SolverOptions ()
 Default constructor.
 ~SolverOptions ()
 Class destructor.
bool IsEqual (SolverOptions *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 (SolverOptions *that)
 A function to make a deep copy of an instance of this class.
bool setSolverOptions (int numberOfOptions, SolverOption **solverOption)
 A function to set an array of solver options.
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.

Public Attributes

int numberOfSolverOptions
 the number of solver options
SolverOption ** solverOption
 the list of solver options

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 3416 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 12077 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 13245 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 14317 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

the number of solver options

Definition at line 3421 of file OSOption.h.

the list of solver options

Definition at line 3424 of file OSOption.h.


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

Generated on 24 Jul 2013 by  doxygen 1.6.1