UserInteraction Class Reference

Encapsulates all user interaction for setting options, logging data and plotting results. More...

#include <user_interaction.hpp>

Inheritance diagram for UserInteraction:

Public Member Functions
virtual int	addPlotWindow (PlotWindow &_window)
virtual int	operator<< (PlotWindow &_window)
virtual int	operator<< (LogRecord &_record)
UserInteraction &	operator= (const UserInteraction &rhs)
	UserInteraction ()
	UserInteraction (const UserInteraction &rhs)
virtual	~UserInteraction ()
Public Member Functions inherited from Options
returnValue	addOptionsList ()
returnValue	ensureConsistency ()
returnValue	ensureConsistency ()
returnValue	get (OptionsName name, int &value) const
returnValue	get (OptionsName name, double &value) const
returnValue	get (OptionsName name, std::string &value) const
returnValue	get (uint idx, OptionsName name, int &value) const
returnValue	get (uint idx, OptionsName name, double &value) const
returnValue	get (uint idx, OptionsName name, std::string &value) const
uint	getNumOptionsLists () const
Options	getOptions (uint idx) const
Options &	operator= (const Options &rhs)
Options &	operator= (const Options &rhs)
	Options ()
	Options ()
	Options (const Options &rhs)
	Options (const Options &rhs)
	Options ()
	Options (const OptionsList &_optionsList)
returnValue	print () const
returnValue	print () const
returnValue	printOptionsList () const
returnValue	printOptionsList (uint idx) const
returnValue	set (OptionsName name, int value)
returnValue	set (OptionsName name, double value)
returnValue	set (OptionsName name, const std::string &value)
returnValue	set (uint idx, OptionsName name, int value)
returnValue	set (uint idx, OptionsName name, double value)
returnValue	set (uint idx, OptionsName name, const std::string &value)
returnValue	setOptions (const Options &arg)
returnValue	setOptions (uint idx, const Options &arg)
returnValue	setToDefault ()
returnValue	setToDefault ()
returnValue	setToFast ()
returnValue	setToFast ()
returnValue	setToMPC ()
returnValue	setToReliable ()
returnValue	setToReliable ()
	~Options ()
	~Options ()
virtual	~Options ()
Public Member Functions inherited from Logging
int	addLogRecord (LogRecord &record)
returnValue	getAll (LogName _name, MatrixVariablesGrid &values) const
returnValue	getFirst (LogName _name, DMatrix &firstValue) const
returnValue	getFirst (LogName _name, VariablesGrid &firstValue) const
returnValue	getLast (LogName _name, DMatrix &lastValue) const
returnValue	getLast (LogName _name, VariablesGrid &lastValue) const
returnValue	getLogRecord (LogRecord &_record) const
uint	getNumLogRecords () const
	Logging ()
int	operator<< (LogRecord &record)
returnValue	printLoggingInfo () const
returnValue	printNumDoubles () const
returnValue	setAll (LogName _name, const MatrixVariablesGrid &values)
returnValue	setLast (LogName _name, const DMatrix &value, double time=-INFTY)
returnValue	setLast (LogName _name, VariablesGrid &value, double time=-INFTY)
returnValue	updateLogRecord (LogRecord &_record) const
virtual	~Logging ()
Public Member Functions inherited from Plotting
int	addPlotWindow (PlotWindow &_window)
uint	getNumPlotWindows () const
returnValue	getPlotWindow (uint idx, PlotWindow &_window) const
returnValue	getPlotWindow (PlotWindow &_window) const
int	operator<< (PlotWindow &_window)
Plotting &	operator= (const Plotting &rhs)
virtual returnValue	plot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
	Plotting ()
	Plotting (const Plotting &rhs)
virtual returnValue	replot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
virtual	~Plotting ()

Protected Member Functions
virtual returnValue	getPlotDataFromMemberLoggings (PlotWindow &_window) const
BlockStatus	getStatus () const
returnValue	setStatus (BlockStatus _status)
Protected Member Functions inherited from Options
returnValue	addOption (OptionsName name, int value)
returnValue	addOption (OptionsName name, double value)
returnValue	addOption (OptionsName name, const std::string &value)
returnValue	addOption (uint idx, OptionsName name, int value)
returnValue	addOption (uint idx, OptionsName name, double value)
returnValue	addOption (uint idx, OptionsName name, const std::string &value)
returnValue	clearOptionsList ()
returnValue	copy (const Options &rhs)
returnValue	copy (const Options &rhs)
returnValue	declareOptionsUnchanged ()
returnValue	declareOptionsUnchanged (uint idx)
BooleanType	haveOptionsChanged () const
BooleanType	haveOptionsChanged (uint idx) const
virtual returnValue	setupOptions ()
Protected Member Functions inherited from Logging
virtual returnValue	setupLogging ()

Protected Attributes
BlockStatus	status
Protected Attributes inherited from Options
std::vector< OptionsList >	lists
Protected Attributes inherited from Logging
std::vector< LogRecord >	logCollection
int	logIdx
Protected Attributes inherited from Plotting
PlotCollection	plotCollection

Additional Inherited Members
Public Attributes inherited from Options
real_t	boundRelaxation
real_t	boundTolerance
int	dropBoundPriority
int_t	dropBoundPriority
int	dropEqConPriority
int_t	dropEqConPriority
int	dropIneqConPriority
int_t	dropIneqConPriority
int	enableCholeskyRefactorisation
int_t	enableCholeskyRefactorisation
int	enableDriftCorrection
int_t	enableDriftCorrection
BooleanType	enableDropInfeasibles
BooleanType	enableEqualities
BooleanType	enableFarBounds
BooleanType	enableFlippingBounds
BooleanType	enableFullLITests
BooleanType	enableInertiaCorrection
BooleanType	enableNZCTests
BooleanType	enableRamping
BooleanType	enableRegularisation
real_t	epsDen
real_t	epsFlipping
real_t	epsIterRef
real_t	epsLITests
real_t	epsNum
real_t	epsNZCTests
real_t	epsRegularisation
real_t	finalRamping
real_t	growFarBounds
real_t	initialFarBounds
real_t	initialRamping
SubjectToStatus	initialStatusBounds
real_t	maxDualJump
real_t	maxPrimalJump
int	numRefinementSteps
int_t	numRefinementSteps
int	numRegularisationSteps
int_t	numRegularisationSteps
PrintLevel	printLevel
real_t	rcondSMin
real_t	terminationTolerance

Detailed Description

Encapsulates all user interaction for setting options, logging data and plotting results.

The class UserInteraction encapsulates all user interaction for setting options, logging data and plotting results.

Author

Hans Joachim Ferreau, Boris Houska

Definition at line 57 of file user_interaction.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO UserInteraction::UserInteraction

(

)

Default constructor.

Definition at line 44 of file user_interaction.cpp.

UserInteraction::UserInteraction

(

const UserInteraction &

rhs

)

Copy constructor (deep copy).

@param[in] rhs      Right-hand side object.

Definition at line 50 of file user_interaction.cpp.

UserInteraction::~UserInteraction ( )

virtual

Destructor.

Definition at line 56 of file user_interaction.cpp.

Member Function Documentation

int UserInteraction::addPlotWindow ( PlotWindow &  _window )

virtual

Adds a window to the plot collection. This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.

Parameters

[in]

_window

Window to be added.

Returns

>= 0: index of added record,
-RET_PLOT_COLLECTION_CORRUPTED

Definition at line 84 of file user_interaction.cpp.

returnValue UserInteraction::getPlotDataFromMemberLoggings ( PlotWindow &  _window ) const

protectedvirtual

Copies all collected logging information required to plot a given window. This function is overloaded within the UserInterface class to syncronize the logging information collected elsewhere within the algorithm with the one stored within the given window for plotting.

Parameters

[in]

_window

Window to be plotted.

Returns

SUCCESSFUL_RETURN

Reimplemented from Plotting.

Definition at line 111 of file user_interaction.cpp.

BlockStatus UserInteraction::getStatus ( ) const

protected

Gets current status of user interface.

Returns

Current status of user interface

Definition at line 125 of file user_interaction.cpp.

int UserInteraction::operator<< ( PlotWindow &  _window )

virtual

Adds a window to the plot collection. This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.

Parameters

[in]

_window

Window to be added.

Note

This function is doing the same as the corresponding addPlotWindow member function and is introduced for syntax reasons only.

Returns

>= 0: index of added record,
-RET_PLOT_COLLECTION_CORRUPTED

Definition at line 77 of file user_interaction.cpp.

int UserInteraction::operator<< ( LogRecord &  _record )

virtual

Adds a record to the log collection.

@param[in] record   Record to be added.

\note This function tunnels the corresponding function of 
      the Logging class. It is introduced to avoid syntax ambiguity only.

Returns

>= 0: index of added record,
-RET_LOG_COLLECTION_CORRUPTED

Definition at line 97 of file user_interaction.cpp.

UserInteraction & UserInteraction::operator=

(

const UserInteraction &

rhs

)

Assignment operator (deep copy).

@param[in] rhs      Right-hand side object.

Definition at line 61 of file user_interaction.cpp.

returnValue UserInteraction::setStatus ( BlockStatus  _status )

protected

Sets status of user interface.

@param[in]  _status         New status of user interface

Returns

SUCCESSFUL_RETURN

Definition at line 131 of file user_interaction.cpp.

Member Data Documentation

BlockStatus UserInteraction::status

protected

Current status of the user interface, see documentation of BlockStatus for details.

Definition at line 165 of file user_interaction.hpp.

---

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

• user_interaction.hpp
• user_interaction.cpp