PlotCollection Class Reference

Provides a generic list of plot windows (for internal use). More...

#include <plot_collection.hpp>

Public Member Functions
int	addPlotWindow (PlotWindow &window)
returnValue	clearAllWindows ()
returnValue	disableNominalControls ()
returnValue	disableNominalOutputs ()
returnValue	disableNominalParameters ()
returnValue	enableNominalControls ()
returnValue	enableNominalOutputs ()
returnValue	enableNominalParameters ()
uint	getNumPlotWindows () const
PlotWindow &	operator() (uint idx)
PlotWindow	operator() (uint idx) const
int	operator<< (PlotWindow &window)
PlotCollection &	operator= (const PlotCollection &rhs)
	PlotCollection ()
	PlotCollection (const PlotCollection &rhs)
	~PlotCollection ()

Protected Attributes
PlotWindow *	first
PlotWindow *	last
uint	number

Friends
class	Plotting

Detailed Description

Provides a generic list of plot windows (for internal use).

The class PlotCollection manages a basic singly-linked list of plot windows that allows to plot algorithmic outputs during runtime. It is intended for internal use only, as all user-functionality is encapsulated within the classes Plotting and PlotWindow.

Author

Hans Joachim Ferreau, Boris Houska

Definition at line 59 of file plot_collection.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO PlotCollection::PlotCollection

(

)

Default constructor.

Definition at line 46 of file plot_collection.cpp.

PlotCollection::PlotCollection

(

const PlotCollection &

rhs

)

Copy constructor (deep copy).

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

Definition at line 55 of file plot_collection.cpp.

PlotCollection::~PlotCollection

(

)

Destructor.

Definition at line 73 of file plot_collection.cpp.

Member Function Documentation

int PlotCollection::addPlotWindow

(

PlotWindow &

window

)

Adds a window to the singly-linked list.

@param[in] window   Window to be added.

Returns

>= 0: index of added window,
-RET_PLOT_COLLECTION_CORRUPTED

Definition at line 106 of file plot_collection.cpp.

returnValue PlotCollection::clearAllWindows

(

)

Clears all windows from the singly-linked list.

Returns

SUCCESSFUL_RETURN

Definition at line 132 of file plot_collection.cpp.

returnValue PlotCollection::disableNominalControls

(

)

Definition at line 169 of file plot_collection.cpp.

returnValue PlotCollection::disableNominalOutputs

(

)

Definition at line 227 of file plot_collection.cpp.

returnValue PlotCollection::disableNominalParameters

(

)

Definition at line 198 of file plot_collection.cpp.

returnValue PlotCollection::enableNominalControls

(

)

Definition at line 155 of file plot_collection.cpp.

returnValue PlotCollection::enableNominalOutputs

(

)

Definition at line 213 of file plot_collection.cpp.

returnValue PlotCollection::enableNominalParameters

(

)

Definition at line 184 of file plot_collection.cpp.

uint PlotCollection::getNumPlotWindows ( ) const

inline

Returns number of windows contained in the plot collection.

Returns

Number of windows

PlotWindow& PlotCollection::operator() ( uint  idx )

inline

Returns the window of the singly-linked list with given index.

@param[in] idx      Index of desired window.

Returns

Window with given index.

PlotWindow PlotCollection::operator() ( uint  idx ) const

inline

Returns the window of the singly-linked list with given index (const version).

@param[in] idx      Index of desired window.

Returns

Window with given index.

int PlotCollection::operator<<

(

PlotWindow &

window

)

Adds a window to the singly-linked list.

@param[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 window,
-RET_PLOT_COLLECTION_CORRUPTED

Definition at line 99 of file plot_collection.cpp.

PlotCollection & PlotCollection::operator=

(

const PlotCollection &

rhs

)

Assignment operator (deep copy).

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

Definition at line 79 of file plot_collection.cpp.

Friends And Related Function Documentation

friend class Plotting

friend

Definition at line 61 of file plot_collection.hpp.

Member Data Documentation

PlotWindow* PlotCollection::first

protected

Pointer to first window of the singly-linked list.

Definition at line 170 of file plot_collection.hpp.

PlotWindow* PlotCollection::last

protected

Pointer to last window of the singly-linked list.

Definition at line 171 of file plot_collection.hpp.

uint PlotCollection::number

protected

Total number of windows within the singly-linked list of the collection.

Definition at line 173 of file plot_collection.hpp.

---

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

• plot_collection.hpp
• plot_collection.cpp