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 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, Gus 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 2295 of file OSOption.h.


Constructor & Destructor Documentation

SolverOptions::SolverOptions (  ) 

Default constructor.

Definition at line 1105 of file OSOption.cpp.

References solverOption.

SolverOptions::~SolverOptions (  ) 

Class destructor.

Definition at line 1114 of file OSOption.cpp.

References numberOfSolverOptions, and solverOption.


Member Function Documentation

bool SolverOptions::IsEqual ( SolverOptions that  ) 

A function to check for the equality of two objects.

Definition at line 8653 of file OSOption.cpp.

References numberOfSolverOptions, and solverOption.

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

References ErrorClass::errormsg, numberOfSolverOptions, and solverOption.

Referenced by OSOption::setSolverOptions().

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

References SolverOption::category, SolverOption::description, ErrorClass::errormsg, SolverOption::name, numberOfSolverOptions, SolverOption::solver, solverOption, SolverOption::type, and SolverOption::value.

Referenced by OSOption::setAnotherSolverOption().


Member Data Documentation

int SolverOptions::numberOfSolverOptions

the number of solver options

Definition at line 2299 of file OSOption.h.

Referenced by addSolverOption(), OSOption::getNumberOfSolverOptions(), IsEqual(), OSOption::setSolverOptions(), setSolverOptions(), and ~SolverOptions().

SolverOption** SolverOptions::solverOption

the list of solver options

Definition at line 2302 of file OSOption.h.

Referenced by addSolverOption(), OSOption::getAllSolverOptions(), IsEqual(), setSolverOptions(), SolverOptions(), and ~SolverOptions().


The documentation for this class was generated from the following files:
Generated on Wed Mar 23 03:09:18 2011 by  doxygen 1.4.7