ACADO Toolkit  1.2.0beta
Toolkit for Automatic Control and Dynamic Optimization
Public Member Functions | Protected Attributes

Provides integer-valued items within the OptionsList (for internal use). More...

#include <options_item_int.hpp>

Inheritance diagram for OptionsItemInt:
Inheritance graph
[legend]

List of all members.

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.
OptionsItemIntoperator= (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.
OptionsItemgetNext () 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.
OptionsItemnext
 Pointer to next item within a OptionsList.

Detailed Description

The class OptionsItemInt provides integer-valued items within the OptionsList.

Author:
Hans Joachim Ferreau, Boris Houska

Constructor & Destructor Documentation

References value.

OptionsItemInt::OptionsItemInt ( OptionsName  _name,
int  _value 
)
Parameters:
[in]_nameName of item.
[in]_valueInitial value of item.

References value.

Parameters:
[in]rhsRight-hand side object.

References value.


Member Function Documentation

OptionsItem * OptionsItem::getNext ( ) const [inline, inherited]
Returns:
New pointer to next item (or NULL iff item is terminal element).

References OptionsItem::next.

Referenced by OptionsList::find(), OptionsList::operator=(), OptionsList::OptionsList(), OptionsList::printOptionsList(), and OptionsList::~OptionsList().

OptionsItemType OptionsItem::getType ( ) const [inline, inherited]
returnValue OptionsItemInt::getValue ( int &  _value) const [virtual]
Parameters:
[out]_valueValue of item.
Returns:
SUCCESSFUL_RETURN

Implements OptionsItem.

References SUCCESSFUL_RETURN, and value.

returnValue OptionsItemInt::getValue ( double &  _value) const [virtual]
Parameters:
[out]_valueValue of item.
Returns:
RET_OPTION_DOESNT_EXISTS

Implements OptionsItem.

References ACADOERROR, and RET_OPTION_DOESNT_EXIST.

OptionsItemInt & OptionsItemInt::operator= ( const OptionsItemInt rhs)
Parameters:
[in]rhsRight-hand side object.

References value.

returnValue OptionsItem::setName ( OptionsName  _name) [inline, inherited]
Parameters:
[in]_nameNew name of item.
Returns:
SUCCESSFUL_RETURN

References OptionsItem::name, and SUCCESSFUL_RETURN.

returnValue OptionsItem::setNext ( OptionsItem *const  _next) [inline, inherited]
Parameters:
[in]_nextNew pointer to next item.
Returns:
SUCCESSFUL_RETURN

References OptionsItem::next, and SUCCESSFUL_RETURN.

Referenced by OptionsList::add().

returnValue OptionsItem::setType ( OptionsItemType  _type) [inline, inherited]
Parameters:
[in]_typeNew internal type of item.
Returns:
SUCCESSFUL_RETURN

References SUCCESSFUL_RETURN, and OptionsItem::type.

returnValue OptionsItemInt::setValue ( int  _value) [virtual]
Parameters:
[in]_valueNew value of item.
Returns:
SUCCESSFUL_RETURN

Implements OptionsItem.

References SUCCESSFUL_RETURN, and value.

returnValue OptionsItemInt::setValue ( double  _value) [virtual]
Parameters:
[in]_valueNew value of item.
Returns:
RET_OPTION_DOESNT_EXISTS

Implements OptionsItem.

References ACADOERROR, and RET_OPTION_DOESNT_EXIST.


Member Data Documentation

OptionsName OptionsItem::name [protected, inherited]
OptionsItem* OptionsItem::next [protected, inherited]
OptionsItemType OptionsItem::type [protected, inherited]
int OptionsItemInt::value [protected]

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines