Public Member Functions | Protected Attributes | Friends

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

#include <plot_collection.hpp>

List of all members.

Public Member Functions

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

Protected Attributes

PlotWindowfirst
PlotWindowlast
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

Default constructor.

Definition at line 46 of file plot_collection.cpp.

Copy constructor (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 55 of file plot_collection.cpp.

Destructor.

Definition at line 73 of file plot_collection.cpp.


Member Function Documentation

Adds a window to the singly-linked list.

Parameters:
[in]windowWindow to be added.
Returns:
>= 0: index of added window,
-RET_PLOT_COLLECTION_CORRUPTED

Definition at line 106 of file plot_collection.cpp.

Clears all windows from the singly-linked list.

Returns:
SUCCESSFUL_RETURN

Definition at line 132 of file plot_collection.cpp.

Definition at line 169 of file plot_collection.cpp.

Definition at line 227 of file plot_collection.cpp.

Definition at line 198 of file plot_collection.cpp.

Definition at line 155 of file plot_collection.cpp.

Definition at line 213 of file plot_collection.cpp.

Definition at line 184 of file plot_collection.cpp.

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.

Parameters:
[in]idxIndex 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).

Parameters:
[in]idxIndex of desired window.
Returns:
Window with given index.
int PlotCollection::operator<< ( PlotWindow window)

Adds a window to the singly-linked list.

Parameters:
[in]windowWindow 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).

Parameters:
[in]rhsRight-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

Pointer to first window of the singly-linked list.

Definition at line 170 of file plot_collection.hpp.

Pointer to last window of the singly-linked list.

Definition at line 171 of file plot_collection.hpp.

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:


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:25