Ipopt::OptionsList::OptionValue Class Reference

Class for storing the value and counter for each option in OptionsList. More...

List of all members.

Public Member Functions

std::string GetValue () const
 Method for retrieving the value of an option.
std::string Value () const
 Method for retrieving the value without increasing the counter.
Index Counter () const
 Method for accessing current value of the request counter.
bool AllowClobber () const
 True if the option can be overwritten.
bool DontPrint () const
 True if this option is not to show up in the print_user_options output.
Constructors/Destructors

 OptionValue ()
 Default constructor (needed for the map).
 OptionValue (std::string value, bool allow_clobber, bool dont_print)
 Constructor given the value.
 OptionValue (const OptionValue &copy)
 Copy Constructor.
void operator= (const OptionValue &copy)
 Equals operator.
 ~OptionValue ()
 Default Destructor.

Private Attributes

std::string value_
 Value for this option.
Index counter_
 Counter for requests.
bool initialized_
 for debugging
bool allow_clobber_
 True if the option can be overwritten.
bool dont_print_
 True if this option is not to show up in the print_user_options output.

Detailed Description

Class for storing the value and counter for each option in OptionsList.

Definition at line 31 of file IpOptionsList.hpp.


Constructor & Destructor Documentation

Ipopt::OptionsList::OptionValue::OptionValue (  )  [inline]

Default constructor (needed for the map).

Definition at line 37 of file IpOptionsList.hpp.

Ipopt::OptionsList::OptionValue::OptionValue ( std::string  value,
bool  allow_clobber,
bool  dont_print 
) [inline]

Constructor given the value.

Definition at line 43 of file IpOptionsList.hpp.

Ipopt::OptionsList::OptionValue::OptionValue ( const OptionValue copy  )  [inline]

Copy Constructor.

Definition at line 53 of file IpOptionsList.hpp.

Ipopt::OptionsList::OptionValue::~OptionValue (  )  [inline]

Default Destructor.

Definition at line 73 of file IpOptionsList.hpp.


Member Function Documentation

void Ipopt::OptionsList::OptionValue::operator= ( const OptionValue copy  )  [inline]

Equals operator.

Definition at line 63 of file IpOptionsList.hpp.

std::string Ipopt::OptionsList::OptionValue::GetValue (  )  const [inline]

Method for retrieving the value of an option.

Calling this method will increase the counter by one.

Definition at line 79 of file IpOptionsList.hpp.

std::string Ipopt::OptionsList::OptionValue::Value (  )  const [inline]

Method for retrieving the value without increasing the counter.

Definition at line 88 of file IpOptionsList.hpp.

Index Ipopt::OptionsList::OptionValue::Counter (  )  const [inline]

Method for accessing current value of the request counter.

Definition at line 95 of file IpOptionsList.hpp.

bool Ipopt::OptionsList::OptionValue::AllowClobber (  )  const [inline]

True if the option can be overwritten.

Definition at line 102 of file IpOptionsList.hpp.

bool Ipopt::OptionsList::OptionValue::DontPrint (  )  const [inline]

True if this option is not to show up in the print_user_options output.

Definition at line 110 of file IpOptionsList.hpp.


Member Data Documentation

Value for this option.

Definition at line 118 of file IpOptionsList.hpp.

Counter for requests.

Definition at line 121 of file IpOptionsList.hpp.

for debugging

Definition at line 124 of file IpOptionsList.hpp.

True if the option can be overwritten.

Definition at line 127 of file IpOptionsList.hpp.

True if this option is not to show up in the print_user_options output.

Definition at line 131 of file IpOptionsList.hpp.


The documentation for this class was generated from the following file:

Generated by  doxygen 1.6.2