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