Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

SbbParam Class Reference

Very simple class for setting parameters. More...

#include <SbbParam.hpp>

List of all members.

stuff

void append (std::string keyWord)
 Insert string (only valid for keywords).

void addHelp (std::string keyWord)
 Adds one help line.

std::string name () const
 Returns name.

std::string shortHelp () const
 Returns short help.

int setDoubleParameter (OsiSolverInterface *model, double value) const
 Sets a double parameter (nonzero code if error).

double doubleParameter (OsiSolverInterface *model) const
 Gets a double parameter.

int setIntParameter (OsiSolverInterface *model, int value) const
 Sets a int parameter (nonzero code if error).

int intParameter (OsiSolverInterface *model) const
 Gets a int parameter.

int setDoubleParameter (SbbModel &model, double value) const
 Sets a double parameter (nonzero code if error).

double doubleParameter (SbbModel &model) const
 Gets a double parameter.

int checkDoubleParameter (double value) const
 Checks a double parameter (nonzero code if error).

int setIntParameter (SbbModel &model, int value) const
 Sets a int parameter (nonzero code if error).

int intParameter (SbbModel &model) const
 Gets a int parameter.

std::string matchName () const
 Returns name which could match.

int parameterOption (std::string check) const
 Returns parameter option which matches (-1 if none).

void printOptions () const
 Prints parameter options.

std::string currentOption () const
 Returns current parameter option.

void setCurrentOption (int value)
 Sets current parameter option.

int matches (std::string input) const
 Returns 1 if matches minimum, 2 if matches less, 0 if not matched.

SbbParameterType type () const
 type

void gutsOfConstructor ()
 gutsOfConstructor


Public Member Functions

Constructor and destructor
 SbbParam ()
 Constructors.

 SbbParam (std::string name, std::string help, double lower, double upper, SbbParameterType type)
 SbbParam (std::string name, std::string help, int lower, int upper, SbbParameterType type)
 SbbParam (std::string name, std::string help, std::string defaultValue, SbbParameterType type)
 SbbParam (std::string name, std::string help, SbbParameterType type)
 SbbParam (const SbbParam &)
 Copy constructor.

SbbParamoperator= (const SbbParam &rhs)
 Assignment operator. This copies the data.

 ~SbbParam ()
 Destructor.


Private Attributes

data
We might as well throw all type data in - could derive?

SbbParameterType type_
double lowerDoubleValue_
 If double == okay.

double upperDoubleValue_
int lowerIntValue_
 If int == okay.

int upperIntValue_
unsigned int lengthName_
unsigned int lengthMatch_
std::vector< std::string > definedKeyWords_
 set of valid strings

std::string name_
 Name.

std::string shortHelp_
 Short help.

std::vector< std::string > longHelp_
 Long help.

SbbParameterType action_
 Action.

int currentKeyWord_
 Current keyWord (if a keyword parameter).


Detailed Description

Very simple class for setting parameters.

Definition at line 57 of file SbbParam.hpp.


The documentation for this class was generated from the following files:
Generated on Wed Dec 3 14:36:26 2003 for Sbb by doxygen 1.3.5