#include <IpRegOptions.hpp>
Inheritance diagram for Ipopt::RegisteredOption:
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 |
Get the option's name (tag in the input file). | |
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 OT_Number | |
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 OT_Integer. | |
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. | |
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 insensitive comparison). | |
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_ |
Classes | |
class | string_entry |
class to hold the valid string settings for a string option More... |
The derived types are more specific to a string option or a Number (real) option, etc.
Definition at line 33 of file IpRegOptions.hpp.
Ipopt::RegisteredOption::RegisteredOption | ( | ) | [inline] |
Ipopt::RegisteredOption::RegisteredOption | ( | const std::string & | name, | |
const std::string & | short_description, | |||
const std::string & | long_description, | |||
const std::string & | registering_category | |||
) | [inline] |
Ipopt::RegisteredOption::RegisteredOption | ( | const RegisteredOption & | copy | ) | [inline] |
virtual Ipopt::RegisteredOption::~RegisteredOption | ( | ) | [inline, virtual] |
Ipopt::RegisteredOption::DECLARE_STD_EXCEPTION | ( | ERROR_CONVERTING_STRING_TO_ENUM | ) |
virtual const std::string& Ipopt::RegisteredOption::Name | ( | ) | const [inline, virtual] |
Get the option's name (tag in the input file).
Definition at line 96 of file IpRegOptions.hpp.
References name_.
virtual void Ipopt::RegisteredOption::SetName | ( | const std::string & | name | ) | [inline, virtual] |
Set the option's name (tag in the input file).
Definition at line 101 of file IpRegOptions.hpp.
References name_.
virtual const std::string& Ipopt::RegisteredOption::ShortDescription | ( | ) | const [inline, virtual] |
Get the short description.
Definition at line 106 of file IpRegOptions.hpp.
References short_description_.
virtual const std::string& Ipopt::RegisteredOption::LongDescription | ( | ) | const [inline, virtual] |
Get the long description.
Definition at line 111 of file IpRegOptions.hpp.
References long_description_.
virtual void Ipopt::RegisteredOption::SetShortDescription | ( | const std::string & | short_description | ) | [inline, virtual] |
Set the short description.
Definition at line 116 of file IpRegOptions.hpp.
References short_description_.
virtual void Ipopt::RegisteredOption::SetLongDescription | ( | const std::string & | long_description | ) | [inline, virtual] |
Set the long description.
Definition at line 121 of file IpRegOptions.hpp.
References long_description_.
virtual const std::string& Ipopt::RegisteredOption::RegisteringCategory | ( | ) | const [inline, virtual] |
Get the registering class.
Definition at line 126 of file IpRegOptions.hpp.
References registering_category_.
virtual void Ipopt::RegisteredOption::SetRegisteringCategory | ( | const std::string & | registering_category | ) | [inline, virtual] |
Set the registering class.
Definition at line 131 of file IpRegOptions.hpp.
References registering_category_.
virtual const RegisteredOptionType& Ipopt::RegisteredOption::Type | ( | ) | const [inline, virtual] |
virtual void Ipopt::RegisteredOption::SetType | ( | const RegisteredOptionType & | type | ) | [inline, virtual] |
virtual Index Ipopt::RegisteredOption::Counter | ( | ) | const [inline, virtual] |
virtual const bool& Ipopt::RegisteredOption::HasLower | ( | ) | const [inline, virtual] |
check if the option has a lower bound - can be called for OT_Number & OT_Integer
Definition at line 158 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, Ipopt::OT_Integer, Ipopt::OT_Number, and type_.
virtual const bool& Ipopt::RegisteredOption::LowerStrict | ( | ) | const [inline, virtual] |
check if the lower bound is strict - can be called for OT_Number
Definition at line 165 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, lower_strict_, Ipopt::OT_Number, and type_.
virtual Number Ipopt::RegisteredOption::LowerNumber | ( | ) | const [inline, virtual] |
get the Number version of the lower bound - can be called for OT_Number
Definition at line 172 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, lower_, Ipopt::OT_Number, and type_.
virtual void Ipopt::RegisteredOption::SetLowerNumber | ( | const Number & | lower, | |
const bool & | strict | |||
) | [inline, virtual] |
set the Number version of the lower bound - can be called for OT_Number
Definition at line 179 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, lower_, lower_strict_, Ipopt::OT_Number, and type_.
virtual Index Ipopt::RegisteredOption::LowerInteger | ( | ) | const [inline, virtual] |
get the Integer version of the lower bound can be called for OT_Integer
Definition at line 187 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, lower_, Ipopt::OT_Integer, and type_.
virtual void Ipopt::RegisteredOption::SetLowerInteger | ( | const Index & | lower | ) | [inline, virtual] |
set the Integer version of the lower bound - can be called for OT_Integer
Definition at line 194 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, lower_, Ipopt::OT_Integer, and type_.
virtual const bool& Ipopt::RegisteredOption::HasUpper | ( | ) | const [inline, virtual] |
check if the option has an upper bound - can be called for OT_Number & OT_Integer
Definition at line 202 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Integer, Ipopt::OT_Number, and type_.
virtual const bool& Ipopt::RegisteredOption::UpperStrict | ( | ) | const [inline, virtual] |
check if the upper bound is strict - can be called for OT_Number
Definition at line 209 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Number, type_, and upper_strict_.
virtual Number Ipopt::RegisteredOption::UpperNumber | ( | ) | const [inline, virtual] |
get the Number version of the upper bound - can be called for OT_Number
Definition at line 216 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Number, type_, and upper_.
virtual void Ipopt::RegisteredOption::SetUpperNumber | ( | const Number & | upper, | |
const bool & | strict | |||
) | [inline, virtual] |
set the Number version of the upper bound - can be called for OT_Number
Definition at line 223 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Number, type_, upper_, and upper_strict_.
virtual Index Ipopt::RegisteredOption::UpperInteger | ( | ) | const [inline, virtual] |
get the Integer version of the upper bound - can be called for OT_Integer
Definition at line 232 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Integer, type_, and upper_.
virtual void Ipopt::RegisteredOption::SetUpperInteger | ( | const Index & | upper | ) | [inline, virtual] |
set the Integer version of the upper bound - can be called for OT_Integer
Definition at line 239 of file IpRegOptions.hpp.
References DBG_ASSERT, has_upper_, Ipopt::OT_Integer, type_, and upper_.
virtual void Ipopt::RegisteredOption::AddValidStringSetting | ( | const std::string | value, | |
const std::string | description | |||
) | [inline, virtual] |
method to add valid string entries - can be called for OT_String
Definition at line 247 of file IpRegOptions.hpp.
References DBG_ASSERT, Ipopt::OT_String, type_, and valid_strings_.
virtual Number Ipopt::RegisteredOption::DefaultNumber | ( | ) | const [inline, virtual] |
get the default as a Number - can be called for OT_Number
Definition at line 254 of file IpRegOptions.hpp.
References DBG_ASSERT, default_number_, Ipopt::OT_Number, and type_.
virtual void Ipopt::RegisteredOption::SetDefaultNumber | ( | const Number & | default_value | ) | [inline, virtual] |
Set the default as a Number - can be called for OT_Number.
Definition at line 260 of file IpRegOptions.hpp.
References DBG_ASSERT, default_number_, Ipopt::OT_Number, and type_.
virtual Index Ipopt::RegisteredOption::DefaultInteger | ( | ) | const [inline, virtual] |
get the default as an Integer - can be called for OT_Integer
Definition at line 266 of file IpRegOptions.hpp.
References DBG_ASSERT, default_number_, Ipopt::OT_Integer, and type_.
virtual void Ipopt::RegisteredOption::SetDefaultInteger | ( | const Index & | default_value | ) | [inline, virtual] |
Set the default as an Integer - can be called for OT_Integer.
Definition at line 273 of file IpRegOptions.hpp.
References DBG_ASSERT, default_number_, Ipopt::OT_Integer, and type_.
virtual std::string Ipopt::RegisteredOption::DefaultString | ( | ) | const [inline, virtual] |
get the default as a string - can be called for OT_String
Definition at line 279 of file IpRegOptions.hpp.
References DBG_ASSERT, default_string_, Ipopt::OT_String, and type_.
virtual Index Ipopt::RegisteredOption::DefaultStringAsEnum | ( | ) | const [inline, virtual] |
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.
References DBG_ASSERT, default_string_, MapStringSettingToEnum(), Ipopt::OT_String, and type_.
virtual void Ipopt::RegisteredOption::SetDefaultString | ( | const std::string & | default_value | ) | [inline, virtual] |
Set the default as a string - can be called for OT_String.
Definition at line 293 of file IpRegOptions.hpp.
References DBG_ASSERT, default_string_, Ipopt::OT_String, and type_.
virtual std::vector<string_entry> Ipopt::RegisteredOption::GetValidStrings | ( | ) | const [inline, virtual] |
get the valid string settings - can be called for OT_String
Definition at line 299 of file IpRegOptions.hpp.
References DBG_ASSERT, Ipopt::OT_String, type_, and valid_strings_.
virtual bool Ipopt::RegisteredOption::IsValidNumberSetting | ( | const Number & | value | ) | const [inline, virtual] |
Check if the Number value is a valid setting - can be called for OT_Number.
Definition at line 306 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, has_upper_, lower_, lower_strict_, Ipopt::OT_Number, type_, upper_, and upper_strict_.
virtual bool Ipopt::RegisteredOption::IsValidIntegerSetting | ( | const Index & | value | ) | const [inline, virtual] |
Check if the Integer value is a valid setting - can be called for OT_Integer.
Definition at line 321 of file IpRegOptions.hpp.
References DBG_ASSERT, has_lower_, has_upper_, lower_, Ipopt::OT_Integer, type_, and upper_.
virtual bool Ipopt::RegisteredOption::IsValidStringSetting | ( | const std::string & | value | ) | const [virtual] |
Check if the String value is a valid setting - can be called for OT_String.
virtual std::string Ipopt::RegisteredOption::MapStringSetting | ( | const std::string & | value | ) | const [virtual] |
Map a user setting (allowing any case) to the case used when the setting was registered.
virtual Index Ipopt::RegisteredOption::MapStringSettingToEnum | ( | const std::string & | value | ) | const [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.
Referenced by DefaultStringAsEnum().
virtual void Ipopt::RegisteredOption::OutputDescription | ( | const Journalist & | jnlst | ) | const [virtual] |
output a description of the option
virtual void Ipopt::RegisteredOption::OutputShortDescription | ( | const Journalist & | jnlst | ) | const [virtual] |
output a more concise version
virtual void Ipopt::RegisteredOption::OutputLatexDescription | ( | const Journalist & | jnlst | ) | const [virtual] |
output a latex version
void Ipopt::RegisteredOption::MakeValidLatexString | ( | std::string | source, | |
std::string & | dest | |||
) | const [private] |
std::string Ipopt::RegisteredOption::MakeValidLatexNumber | ( | Number | value | ) | const [private] |
bool Ipopt::RegisteredOption::string_equal_insensitive | ( | const std::string & | s1, | |
const std::string & | s2 | |||
) | const [private] |
Compare two strings and return true if they are equal (case insensitive comparison).
std::string Ipopt::RegisteredOption::name_ [private] |
std::string Ipopt::RegisteredOption::short_description_ [private] |
Definition at line 357 of file IpRegOptions.hpp.
Referenced by SetShortDescription(), and ShortDescription().
std::string Ipopt::RegisteredOption::long_description_ [private] |
Definition at line 358 of file IpRegOptions.hpp.
Referenced by LongDescription(), and SetLongDescription().
std::string Ipopt::RegisteredOption::registering_category_ [private] |
Definition at line 359 of file IpRegOptions.hpp.
Referenced by RegisteringCategory(), and SetRegisteringCategory().
Definition at line 360 of file IpRegOptions.hpp.
Referenced by AddValidStringSetting(), DefaultInteger(), DefaultNumber(), DefaultString(), DefaultStringAsEnum(), GetValidStrings(), HasLower(), HasUpper(), IsValidIntegerSetting(), IsValidNumberSetting(), LowerInteger(), LowerNumber(), LowerStrict(), SetDefaultInteger(), SetDefaultNumber(), SetDefaultString(), SetLowerInteger(), SetLowerNumber(), SetType(), SetUpperInteger(), SetUpperNumber(), Type(), UpperInteger(), UpperNumber(), and UpperStrict().
bool Ipopt::RegisteredOption::has_lower_ [private] |
Definition at line 362 of file IpRegOptions.hpp.
Referenced by HasLower(), IsValidIntegerSetting(), IsValidNumberSetting(), LowerInteger(), LowerNumber(), LowerStrict(), SetLowerInteger(), and SetLowerNumber().
bool Ipopt::RegisteredOption::lower_strict_ [private] |
Definition at line 363 of file IpRegOptions.hpp.
Referenced by IsValidNumberSetting(), LowerStrict(), and SetLowerNumber().
Number Ipopt::RegisteredOption::lower_ [private] |
Definition at line 364 of file IpRegOptions.hpp.
Referenced by IsValidIntegerSetting(), IsValidNumberSetting(), LowerInteger(), LowerNumber(), SetLowerInteger(), and SetLowerNumber().
bool Ipopt::RegisteredOption::has_upper_ [private] |
Definition at line 365 of file IpRegOptions.hpp.
Referenced by HasUpper(), IsValidIntegerSetting(), IsValidNumberSetting(), SetUpperInteger(), SetUpperNumber(), UpperInteger(), UpperNumber(), and UpperStrict().
bool Ipopt::RegisteredOption::upper_strict_ [private] |
Definition at line 366 of file IpRegOptions.hpp.
Referenced by IsValidNumberSetting(), SetUpperNumber(), and UpperStrict().
Number Ipopt::RegisteredOption::upper_ [private] |
Definition at line 367 of file IpRegOptions.hpp.
Referenced by IsValidIntegerSetting(), IsValidNumberSetting(), SetUpperInteger(), SetUpperNumber(), UpperInteger(), and UpperNumber().
Definition at line 368 of file IpRegOptions.hpp.
Referenced by DefaultInteger(), DefaultNumber(), SetDefaultInteger(), and SetDefaultNumber().
std::vector<string_entry> Ipopt::RegisteredOption::valid_strings_ [private] |
Definition at line 378 of file IpRegOptions.hpp.
Referenced by AddValidStringSetting(), and GetValidStrings().
std::string Ipopt::RegisteredOption::default_string_ [private] |
Definition at line 379 of file IpRegOptions.hpp.
Referenced by DefaultString(), DefaultStringAsEnum(), and SetDefaultString().
const Index Ipopt::RegisteredOption::counter_ [private] |
Has the information as how many-th option this one was registered.
Definition at line 383 of file IpRegOptions.hpp.
Referenced by Counter().
Index Ipopt::RegisteredOption::next_counter_ [static, private] |
Definition at line 385 of file IpRegOptions.hpp.