Base class for registered options. More...
#include <IpRegOptions.hpp>
Classes | |
class | string_entry |
class to hold the valid string settings for a string option More... |
Public Member Functions | |
DECLARE_STD_EXCEPTION (ERROR_CONVERTING_STRING_TO_ENUM) | |
virtual void | OutputDescription (const Journalist &jnlst) const |
output a description of the option | |
virtual void | OutputShortDescription (const Journalist &jnlst) const |
output a more concise version | |
virtual void | OutputLatexDescription (const Journalist &jnlst) const |
output a latex version | |
RegisteredOption () | |
Constructors / Destructors. | |
RegisteredOption (const std::string &name, const std::string &short_description, const std::string &long_description, const std::string ®istering_category) | |
Constructors / Destructors. | |
RegisteredOption (const RegisteredOption ©) | |
Constructors / Destructors. | |
virtual | ~RegisteredOption () |
Constructors / Destructors. | |
virtual const std::string & | Name () const |
Standard Get / Set Methods. | |
virtual void | SetName (const std::string &name) |
Set the option's name (tag in the input file) | |
virtual const std::string & | ShortDescription () const |
Get the short description. | |
virtual const std::string & | LongDescription () const |
Get the long description. | |
virtual void | SetShortDescription (const std::string &short_description) |
Set the short description. | |
virtual void | SetLongDescription (const std::string &long_description) |
Set the long description. | |
virtual const std::string & | RegisteringCategory () const |
Get the registering class. | |
virtual void | SetRegisteringCategory (const std::string ®istering_category) |
Set the registering class. | |
virtual const RegisteredOptionType & | Type () const |
Get the Option's type. | |
virtual void | SetType (const RegisteredOptionType &type) |
Get the Option's type. | |
virtual Index | Counter () const |
Counter. | |
Get / Set methods valid for specific types - NOTE: the Type | |
must be set before calling these methods. | |
virtual const bool & | HasLower () const |
check if the option has a lower bound - can be called for OT_Number & OT_Integer | |
virtual const bool & | LowerStrict () const |
check if the lower bound is strict - can be called for | |
virtual Number | LowerNumber () const |
get the Number version of the lower bound - can be called for OT_Number | |
virtual void | SetLowerNumber (const Number &lower, const bool &strict) |
set the Number version of the lower bound - can be called for OT_Number | |
virtual Index | LowerInteger () const |
get the Integer version of the lower bound can be called for OT_Integer | |
virtual void | SetLowerInteger (const Index &lower) |
set the Integer version of the lower bound - can be called for OT_Integer | |
virtual const bool & | HasUpper () const |
check if the option has an upper bound - can be called for OT_Number & OT_Integer | |
virtual const bool & | UpperStrict () const |
check if the upper bound is strict - can be called for OT_Number | |
virtual Number | UpperNumber () const |
get the Number version of the upper bound - can be called for OT_Number | |
virtual void | SetUpperNumber (const Number &upper, const bool &strict) |
set the Number version of the upper bound - can be called for OT_Number | |
virtual Index | UpperInteger () const |
get the Integer version of the upper bound - can be called for OT_Integer | |
virtual void | SetUpperInteger (const Index &upper) |
set the Integer version of the upper bound - can be called for OT_Integer | |
virtual void | AddValidStringSetting (const std::string value, const std::string description) |
method to add valid string entries - can be called for OT_String | |
virtual Number | DefaultNumber () const |
get the default as a Number - can be called for OT_Number | |
virtual void | SetDefaultNumber (const Number &default_value) |
Set the default as a Number - can be called for OT_Number. | |
virtual Index | DefaultInteger () const |
get the default as an Integer - can be called for OT_Integer | |
virtual void | SetDefaultInteger (const Index &default_value) |
Set the default as an Integer - can be called for | |
virtual std::string | DefaultString () const |
get the default as a string - can be called for OT_String | |
virtual Index | DefaultStringAsEnum () const |
get the default as a string, but as the index of the string in the list - helps map from a string to an enum- can be called for OT_String | |
virtual void | SetDefaultString (const std::string &default_value) |
Set the default as a string - can be called for OT_String. | |
virtual std::vector< string_entry > | GetValidStrings () const |
get the valid string settings - can be called for OT_String | |
virtual bool | IsValidNumberSetting (const Number &value) const |
Check if the Number value is a valid setting - can be called for OT_Number. | |
virtual bool | IsValidIntegerSetting (const Index &value) const |
Check if the Integer value is a valid setting - can be called for OT_Integer. | |
virtual bool | IsValidStringSetting (const std::string &value) const |
Check if the String value is a valid setting - can be called for OT_String. | |
virtual std::string | MapStringSetting (const std::string &value) const |
Map a user setting (allowing any case) to the case used when the setting was registered. | |
virtual Index | MapStringSettingToEnum (const std::string &value) const |
Map a user setting (allowing any case) to the index of the matched setting in the list of string settings. | |
![]() | |
ReferencedObject () | |
virtual | ~ReferencedObject () |
Index | ReferenceCount () const |
void | AddRef (const Referencer *referencer) const |
void | ReleaseRef (const Referencer *referencer) const |
Private Member Functions | |
void | MakeValidLatexString (std::string source, std::string &dest) const |
std::string | MakeValidLatexNumber (Number value) const |
bool | string_equal_insensitive (const std::string &s1, const std::string &s2) const |
Compare two strings and return true if they are equal (case |
Private Attributes | |
std::string | name_ |
std::string | short_description_ |
std::string | long_description_ |
std::string | registering_category_ |
RegisteredOptionType | type_ |
bool | has_lower_ |
bool | lower_strict_ |
Number | lower_ |
bool | has_upper_ |
bool | upper_strict_ |
Number | upper_ |
Number | default_number_ |
std::vector< string_entry > | valid_strings_ |
std::string | default_string_ |
const Index | counter_ |
Has the information as how many-th option this one was registered. |
Static Private Attributes | |
static Index | next_counter_ |
Base class for registered options.
The derived types are more specific to a string option or a Number (real) option, etc.
Definition at line 33 of file IpRegOptions.hpp.
|
inline |
Constructors / Destructors.
Definition at line 49 of file IpRegOptions.hpp.
|
inline |
Constructors / Destructors.
Definition at line 57 of file IpRegOptions.hpp.
|
inline |
Constructors / Destructors.
Definition at line 72 of file IpRegOptions.hpp.
|
inlinevirtual |
Constructors / Destructors.
Definition at line 87 of file IpRegOptions.hpp.
Ipopt::RegisteredOption::DECLARE_STD_EXCEPTION | ( | ERROR_CONVERTING_STRING_TO_ENUM | ) |
|
inlinevirtual |
Standard Get / Set Methods.
Get the option's name (tag in the input file)
Definition at line 96 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the option's name (tag in the input file)
Definition at line 101 of file IpRegOptions.hpp.
|
inlinevirtual |
Get the short description.
Definition at line 106 of file IpRegOptions.hpp.
|
inlinevirtual |
Get the long description.
Definition at line 111 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the short description.
Definition at line 116 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the long description.
Definition at line 121 of file IpRegOptions.hpp.
|
inlinevirtual |
Get the registering class.
Definition at line 126 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the registering class.
Definition at line 131 of file IpRegOptions.hpp.
|
inlinevirtual |
Get the Option's type.
Definition at line 136 of file IpRegOptions.hpp.
|
inlinevirtual |
Get the Option's type.
Definition at line 141 of file IpRegOptions.hpp.
|
inlinevirtual |
Counter.
Definition at line 146 of file IpRegOptions.hpp.
|
inlinevirtual |
check if the option has a lower bound - can be called for OT_Number & OT_Integer
Definition at line 158 of file IpRegOptions.hpp.
|
inlinevirtual |
check if the lower bound is strict - can be called for
OT_Number
Definition at line 165 of file IpRegOptions.hpp.
|
inlinevirtual |
get the Number version of the lower bound - can be called for OT_Number
Definition at line 172 of file IpRegOptions.hpp.
|
inlinevirtual |
set the Number version of the lower bound - can be called for OT_Number
Definition at line 179 of file IpRegOptions.hpp.
|
inlinevirtual |
get the Integer version of the lower bound can be called for OT_Integer
Definition at line 187 of file IpRegOptions.hpp.
|
inlinevirtual |
set the Integer version of the lower bound - can be called for OT_Integer
Definition at line 194 of file IpRegOptions.hpp.
|
inlinevirtual |
check if the option has an upper bound - can be called for OT_Number & OT_Integer
Definition at line 202 of file IpRegOptions.hpp.
|
inlinevirtual |
check if the upper bound is strict - can be called for OT_Number
Definition at line 209 of file IpRegOptions.hpp.
|
inlinevirtual |
get the Number version of the upper bound - can be called for OT_Number
Definition at line 216 of file IpRegOptions.hpp.
|
inlinevirtual |
set the Number version of the upper bound - can be called for OT_Number
Definition at line 223 of file IpRegOptions.hpp.
|
inlinevirtual |
get the Integer version of the upper bound - can be called for OT_Integer
Definition at line 232 of file IpRegOptions.hpp.
|
inlinevirtual |
set the Integer version of the upper bound - can be called for OT_Integer
Definition at line 239 of file IpRegOptions.hpp.
|
inlinevirtual |
method to add valid string entries - can be called for OT_String
Definition at line 247 of file IpRegOptions.hpp.
|
inlinevirtual |
get the default as a Number - can be called for OT_Number
Definition at line 254 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the default as a Number - can be called for OT_Number.
Definition at line 260 of file IpRegOptions.hpp.
|
inlinevirtual |
get the default as an Integer - can be called for OT_Integer
Definition at line 266 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the default as an Integer - can be called for
OT_Integer
Definition at line 273 of file IpRegOptions.hpp.
|
inlinevirtual |
get the default as a string - can be called for OT_String
Definition at line 279 of file IpRegOptions.hpp.
|
inlinevirtual |
get the default as a string, but as the index of the string in the list - helps map from a string to an enum- can be called for OT_String
Definition at line 287 of file IpRegOptions.hpp.
|
inlinevirtual |
Set the default as a string - can be called for OT_String.
Definition at line 293 of file IpRegOptions.hpp.
|
inlinevirtual |
get the valid string settings - can be called for OT_String
Definition at line 299 of file IpRegOptions.hpp.
|
inlinevirtual |
Check if the Number value is a valid setting - can be called for OT_Number.
Definition at line 306 of file IpRegOptions.hpp.
|
inlinevirtual |
Check if the Integer value is a valid setting - can be called for OT_Integer.
Definition at line 321 of file IpRegOptions.hpp.
|
virtual |
Check if the String value is a valid setting - can be called for OT_String.
|
virtual |
Map a user setting (allowing any case) to the case used when the setting was registered.
|
virtual |
Map a user setting (allowing any case) to the index of the matched setting in the list of string settings.
Helps map a string setting to an enumeration.
|
virtual |
output a description of the option
|
virtual |
output a more concise version
|
virtual |
output a latex version
|
private |
|
private |
|
private |
Compare two strings and return true if they are equal (case
insensitive comparison)
|
private |
Definition at line 356 of file IpRegOptions.hpp.
|
private |
Definition at line 357 of file IpRegOptions.hpp.
|
private |
Definition at line 358 of file IpRegOptions.hpp.
|
private |
Definition at line 359 of file IpRegOptions.hpp.
|
private |
Definition at line 360 of file IpRegOptions.hpp.
|
private |
Definition at line 362 of file IpRegOptions.hpp.
|
private |
Definition at line 363 of file IpRegOptions.hpp.
|
private |
Definition at line 364 of file IpRegOptions.hpp.
|
private |
Definition at line 365 of file IpRegOptions.hpp.
|
private |
Definition at line 366 of file IpRegOptions.hpp.
|
private |
Definition at line 367 of file IpRegOptions.hpp.
|
private |
Definition at line 368 of file IpRegOptions.hpp.
|
private |
Definition at line 378 of file IpRegOptions.hpp.
|
private |
Definition at line 379 of file IpRegOptions.hpp.
|
private |
Has the information as how many-th option this one was registered.
Definition at line 383 of file IpRegOptions.hpp.
|
staticprivate |
Definition at line 385 of file IpRegOptions.hpp.