|
virtual void | clear () |
| Method for clearing all previously set options. More...
|
|
virtual void | PrintList (std::string &list) const |
| Get a string with the list of all options (tag, value, counter) More...
|
|
virtual void | PrintUserOptions (std::string &list) const |
| Get a string with the list of all options set by the user (tag, value, use/notused). More...
|
|
virtual bool | ReadFromStream (const Journalist &jnlst, std::istream &is, bool allow_clobber=false) |
| Read options from the stream is. More...
|
|
|
| OptionsList (SmartPtr< RegisteredOptions > reg_options, SmartPtr< Journalist > jnlst) |
|
| OptionsList () |
|
| OptionsList (const OptionsList ©) |
| Copy Constructor. More...
|
|
virtual | ~OptionsList () |
| Default destructor. More...
|
|
virtual void | operator= (const OptionsList &source) |
| Overloaded Equals Operator. More...
|
|
|
virtual void | SetRegisteredOptions (const SmartPtr< RegisteredOptions > reg_options) |
|
virtual void | SetJournalist (const SmartPtr< Journalist > jnlst) |
|
|
virtual bool | SetStringValue (const std::string &tag, const std::string &value, bool allow_clobber=true, bool dont_print=false) |
|
virtual bool | SetNumericValue (const std::string &tag, Number value, bool allow_clobber=true, bool dont_print=false) |
|
virtual bool | SetIntegerValue (const std::string &tag, Index value, bool allow_clobber=true, bool dont_print=false) |
|
|
|
virtual bool | SetStringValueIfUnset (const std::string &tag, const std::string &value, bool allow_clobber=true, bool dont_print=false) |
|
virtual bool | SetNumericValueIfUnset (const std::string &tag, Number value, bool allow_clobber=true, bool dont_print=false) |
|
virtual bool | SetIntegerValueIfUnset (const std::string &tag, Index value, bool allow_clobber=true, bool dont_print=false) |
|
|
a tag is not found, the methods return false, and value is set to the default value defined in the registered options.
|
virtual bool | GetStringValue (const std::string &tag, std::string &value, const std::string &prefix) const |
|
virtual bool | GetEnumValue (const std::string &tag, Index &value, const std::string &prefix) const |
|
virtual bool | GetBoolValue (const std::string &tag, bool &value, const std::string &prefix) const |
|
virtual bool | GetNumericValue (const std::string &tag, Number &value, const std::string &prefix) const |
|
virtual bool | GetIntegerValue (const std::string &tag, Index &value, const std::string &prefix) const |
|
| ReferencedObject () |
|
virtual | ~ReferencedObject () |
|
Index | ReferenceCount () const |
|
void | AddRef (const Referencer *referencer) const |
|
void | ReleaseRef (const Referencer *referencer) const |
|
|
const std::string & | lowercase (const std::string tag) const |
| auxilliary method for converting sting to all lower-case letters More...
|
|
bool | find_tag (const std::string &tag, const std::string &prefix, std::string &value) const |
| auxilliary method for finding the value for a tag in the options list. More...
|
|
bool | will_allow_clobber (const std::string &tag) const |
| tells whether or not we can clobber a particular option. More...
|
|
bool | readnexttoken (std::istream &is, std::string &token) |
| read the next token from stream is. More...
|
|
This class stores a list of user set options.
Each options is identified by a case-insensitive keyword (tag). Its value is stored internally as a string (always lower case), but for convenience set and get methods are provided to obtain Index and Number type values. For each keyword we also keep track of how often the value of an option has been requested by a get method.
Definition at line 32 of file IpOptionsList.hpp.
bool Ipopt::OptionsList::find_tag |
( |
const std::string & |
tag, |
|
|
const std::string & |
prefix, |
|
|
std::string & |
value |
|
) |
| const |
|
private |
auxilliary method for finding the value for a tag in the options list.
This method first looks for the concatenated string prefix+tag (if prefix is not ""), and if this is not found, it looks for tag. The return value is true iff prefix+tag or tag is found. In that case, the corresponding string value is copied into value.