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

ClpItem Class Reference

Very simple class for setting parameters. More...

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 (ClpSimplex *model, double value) const
 Sets a double parameter (nonzero code if error).

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

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

int intParameter (ClpSimplex *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.

void setIntValue (int value)
 Sets int value.

int intValue () const
void setDoubleValue (double value)
 Sets double value.

double doubleValue () const
void setStringValue (std::string value)
 Sets string value.

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

ClpParameterType type () const
 type

bool displayThis () const
 whether to display

void setLonghelp (const std::string help)
 Set Long help.

void printLongHelp () const
 Print Long help.

void printString () const
 Print action and string.

int indexNumber () const
 type for classification

void gutsOfConstructor ()
 gutsOfConstructor


Public Member Functions

Constructor and destructor
 ClpItem ()
 Constructors.

 ClpItem (std::string name, std::string help, double lower, double upper, ClpParameterType type, bool display=true)
 ClpItem (std::string name, std::string help, int lower, int upper, ClpParameterType type, bool display=true)
 ClpItem (std::string name, std::string help, std::string firstValue, ClpParameterType type, int defaultIndex=0, bool display=true)
 ClpItem (std::string name, std::string help, ClpParameterType type, int indexNumber=-1, bool display=true)
 ClpItem (const ClpItem &)
 Copy constructor.

ClpItemoperator= (const ClpItem &rhs)
 Assignment operator. This copies the data.

 ~ClpItem ()
 Destructor.


Private Attributes

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

ClpParameterType 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::string longHelp_
 Long help.

ClpParameterType action_
 Action.

int currentKeyWord_
 Current keyWord (if a keyword parameter).

bool display_
 Display on ?

int intValue_
 Integer parameter - current value.

double doubleValue_
 Double parameter - current value.

std::string stringValue_
 String parameter - current value.

int indexNumber_
 index number to use for display purposes


Detailed Description

Very simple class for setting parameters.

Definition at line 95 of file ClpMain.cpp.


The documentation for this class was generated from the following file:
Generated on Wed Dec 3 14:37:38 2003 for CLP by doxygen 1.3.5