ACADO Toolkit
1.2.0beta
Toolkit for Automatic Control and Dynamic Optimization
|
Provides integer-valued items within the OptionsList (for internal use). More...
#include <options_item_int.hpp>
Public Member Functions | |
OptionsItemInt () | |
Default constructor. | |
OptionsItemInt (OptionsName _name, int _value) | |
Constructor which takes the name and initial value of the item. | |
OptionsItemInt (const OptionsItemInt &rhs) | |
Copy constructor (deep copy). | |
virtual | ~OptionsItemInt () |
Destructor. | |
OptionsItemInt & | operator= (const OptionsItemInt &rhs) |
Assignment operator (deep copy). | |
virtual returnValue | getValue (int &_value) const |
Returns value of item of integer type. | |
virtual returnValue | getValue (double &_value) const |
Returns value of item of double type. | |
virtual returnValue | setValue (int _value) |
Sets value of item of integer type. | |
virtual returnValue | setValue (double _value) |
Sets value of item of integer type. | |
OptionsName | getName () const |
Returns name of item. | |
OptionsItemType | getType () const |
Returns type of item. | |
returnValue | setName (OptionsName _name) |
Sets name of item. | |
returnValue | setType (OptionsItemType _type) |
Sets internal type of item. | |
OptionsItem * | getNext () const |
Returns pointer to next OptionsItem within a OptionsList. | |
returnValue | setNext (OptionsItem *const _next) |
Assigns pointer to next OptionsItem within a OptionsList. | |
Protected Attributes | |
int | value |
Value of item of integer type. | |
OptionsName | name |
Name of item. | |
OptionsItemType | type |
Internal type of item. | |
OptionsItem * | next |
Pointer to next item within a OptionsList. |
The class OptionsItemInt provides integer-valued items within the OptionsList.
References value.
OptionsItemInt::OptionsItemInt | ( | OptionsName | _name, |
int | _value | ||
) |
[in] | _name | Name of item. |
[in] | _value | Initial value of item. |
References value.
OptionsItemInt::OptionsItemInt | ( | const OptionsItemInt & | rhs | ) |
[in] | rhs | Right-hand side object. |
References value.
OptionsItemInt::~OptionsItemInt | ( | ) | [virtual] |
BEGIN_NAMESPACE_ACADO OptionsName OptionsItem::getName | ( | ) | const [inline, inherited] |
References OptionsItem::name.
Referenced by OptionsList::find(), OptionsList::operator=(), OptionsList::OptionsList(), and OptionsList::printOptionsList().
OptionsItem * OptionsItem::getNext | ( | ) | const [inline, inherited] |
References OptionsItem::next.
Referenced by OptionsList::find(), OptionsList::operator=(), OptionsList::OptionsList(), OptionsList::printOptionsList(), and OptionsList::~OptionsList().
OptionsItemType OptionsItem::getType | ( | ) | const [inline, inherited] |
References OptionsItem::type.
Referenced by OptionsList::find(), OptionsList::operator=(), OptionsList::OptionsList(), and OptionsList::printOptionsList().
returnValue OptionsItemInt::getValue | ( | int & | _value | ) | const [virtual] |
[out] | _value | Value of item. |
Implements OptionsItem.
References SUCCESSFUL_RETURN, and value.
returnValue OptionsItemInt::getValue | ( | double & | _value | ) | const [virtual] |
[out] | _value | Value of item. |
Implements OptionsItem.
References ACADOERROR, and RET_OPTION_DOESNT_EXIST.
OptionsItemInt & OptionsItemInt::operator= | ( | const OptionsItemInt & | rhs | ) |
[in] | rhs | Right-hand side object. |
References value.
returnValue OptionsItem::setName | ( | OptionsName | _name | ) | [inline, inherited] |
[in] | _name | New name of item. |
References OptionsItem::name, and SUCCESSFUL_RETURN.
returnValue OptionsItem::setNext | ( | OptionsItem *const | _next | ) | [inline, inherited] |
[in] | _next | New pointer to next item. |
References OptionsItem::next, and SUCCESSFUL_RETURN.
Referenced by OptionsList::add().
returnValue OptionsItem::setType | ( | OptionsItemType | _type | ) | [inline, inherited] |
[in] | _type | New internal type of item. |
References SUCCESSFUL_RETURN, and OptionsItem::type.
returnValue OptionsItemInt::setValue | ( | int | _value | ) | [virtual] |
[in] | _value | New value of item. |
Implements OptionsItem.
References SUCCESSFUL_RETURN, and value.
returnValue OptionsItemInt::setValue | ( | double | _value | ) | [virtual] |
[in] | _value | New value of item. |
Implements OptionsItem.
References ACADOERROR, and RET_OPTION_DOESNT_EXIST.
OptionsName OptionsItem::name [protected, inherited] |
Referenced by OptionsItem::getName(), OptionsItem::operator=(), OptionsItem::OptionsItem(), and OptionsItem::setName().
OptionsItem* OptionsItem::next [protected, inherited] |
Referenced by OptionsItem::getNext(), OptionsItem::operator=(), OptionsItem::OptionsItem(), and OptionsItem::setNext().
OptionsItemType OptionsItem::type [protected, inherited] |
Referenced by OptionsItem::getType(), OptionsItem::operator=(), OptionsItem::OptionsItem(), and OptionsItem::setType().
int OptionsItemInt::value [protected] |
Referenced by getValue(), operator=(), OptionsItemInt(), and setValue().