129 double lower,
double upper,
double dflt = 0.0,
137 int lower,
int upper,
int dflt = 0,
155 std::string firstValue,
int dflt,
bool display =
true);
166 std::string dflt,
bool display =
true);
202 int kwdIndex(std::string kwd)
const;
207 std::string
kwdVal()
const;
236 std::string
strVal()
const;
315 int matches(std::string input)
const;
471 std::string
getStringField(
int argc,
const char *argv[],
int *valid);
480 int getIntField(
int argc,
const char *argv[],
int *valid);
504 int &matchNdx,
int &shortCnt);
536 std::string
getCommand(
int argc,
const char *argv[],
537 const std::string prompt, std::string *pfx = 0);
577 int *matchCnt = 0,
int *shortCnt = 0,
int *queryCnt = 0);
615 std::string name,
int numQuery);
std::string strVal() const
Get the value of a string parameter.
std::string strValue_
String parameter - current value.
CoinParam & operator=(const CoinParam &rhs)
Assignment.
CoinParamFunc pushFunc()
Get push function.
std::string shortHelp() const
Retrieve the short help string.
int(* CoinParamFunc)(CoinParam *param)
Type declaration for push and pull functions.
std::vector< CoinParam *> CoinParamVec
A type for a parameter vector.
int currentKwd_
Current value for a keyword parameter (index into definedKwds_)
std::string shortHelp_
Short help.
void shortOrHelpOne(CoinParamVec ¶mVec, int matchNdx, std::string name, int numQuery)
Utility routine to print help given a short match or explicit request for help.
void setDblVal(double value)
Set the value of a double parameter.
void printIt(const char *msg)
Utility to print a long message as filled lines of text.
std::string longHelp_
Long help.
void setIntVal(int value)
Set the value of a integer parameter.
void printLongHelp() const
Print long help.
double getDoubleField(int argc, const char *argv[], int *valid)
Attempt to read a real (double) from the input.
CoinParam()
Default constructor.
A base class for `keyword value' command line parameters.
std::string getStringField(int argc, const char *argv[], int *valid)
Attempt to read a string from the input.
void setLongHelp(const std::string help)
Add a long help message to a parameter.
void setPushFunc(CoinParamFunc func)
Set push function.
int kwdIndex(std::string kwd) const
Return the integer associated with the specified value-keyword.
CoinParamFunc pushFunc_
Push function.
void processName()
Process a name for efficient matching.
virtual CoinParam * clone()
Clone.
std::string longHelp() const
Retrieve the long help message.
void setName(std::string name)
Set the parameter keyword (name) string.
CoinParamFunc pullFunc_
Pull function.
Utility functions for processing CoinParam parameters.
CoinParamType type_
Parameter type (see CoinParamType)
double lowerDblValue_
Lower bound on value for a double parameter.
virtual ~CoinParam()
Destructor.
std::vector< std::string > definedKwds_
Set of valid value-keywords for a keyword parameter.
bool isInteractive()
Returns true if parameters are being obtained from stdin.
void printKwds() const
Prints the set of value-keywords defined for this keyword parameter.
double dblVal() const
Get the value of a double parameter.
CoinParamType
Enumeration for the types of parameters supported by CoinParam.
std::string kwdVal() const
Return the value-keyword that is the current value of the keyword parameter.
void setShortHelp(const std::string help)
Add a short help string to a parameter.
void printHelp(CoinParamVec ¶mVec, int firstParam, int lastParam, std::string prefix, bool shortHelp, bool longHelp, bool hidden)
Utility routine to print help messages for one or more parameters.
CoinParamFunc pullFunc()
Get pull function.
int intVal() const
Get the value of a integer parameter.
size_t lengthName_
Length of parameter name.
double upperDblValue_
Upper bound on value for a double parameter.
int lowerIntValue_
Lower bound on value for an integer parameter.
int getIntField(int argc, const char *argv[], int *valid)
Attempt to read an integer from the input.
std::string matchName() const
Return the parameter keyword (name) string formatted to show the minimum match length.
bool display() const
Get visibility of parameter.
bool display_
Display when processing lists of parameters?
void printGenericHelp()
Print a generic `how to use the command interface' help message.
std::string name() const
Return the parameter keyword (name) string.
void setType(CoinParamType type)
Set the type of the parameter.
CoinParamType type() const
Return the type of the parameter.
int lookupParam(std::string name, CoinParamVec ¶mVec, int *matchCnt=0, int *shortCnt=0, int *queryCnt=0)
Look up the command keyword (name) in the parameter vector. Print help if requested.
double dblValue_
Double parameter - current value.
int matchParam(const CoinParamVec ¶mVec, std::string name, int &matchNdx, int &shortCnt)
Scan a parameter vector for parameters whose keyword (name) string matches name using minimal match r...
void shortOrHelpMany(CoinParamVec ¶mVec, std::string name, int numQuery)
Utility routine to print help given multiple matches.
void setKwdVal(int value, bool printIt=false)
Set the value of the keyword parameter using the integer associated with a value-keyword.
std::string name_
Parameter name.
int upperIntValue_
Upper bound on value for an integer parameter.
void appendKwd(std::string kwd)
Add an additional value-keyword to a keyword parameter.
void setPullFunc(CoinParamFunc func)
Set pull function.
void setInputSrc(FILE *src)
Take command input from the file specified by src.
std::ostream & operator<<(std::ostream &s, const CoinParam ¶m)
A stream output function for a CoinParam object.
size_t lengthMatch_
Minimum length required to declare a match for the parameter name.
bool isCommandLine()
Returns true if command line parameters are being processed.
void setStrVal(std::string value)
Set the value of a string parameter.
std::string getCommand(int argc, const char *argv[], const std::string prompt, std::string *pfx=0)
Get the next command keyword (name)
int intValue_
Integer parameter - current value.
int matches(std::string input) const
Check if the specified string matches the parameter keyword (name) string.
void setDisplay(bool display)
Set visibility of parameter.