Provides a generic way to plot algorithmic outputs during runtime. More...
#include <plotting.hpp>
Public Member Functions | |
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 |
Protected Attributes | |
PlotCollection | plotCollection |
Friends | |
class | AlgorithmicBase |
Provides a generic way to plot algorithmic outputs during runtime.
The class Plotting provides a generic way to plot algorithmic outputs during runtime. This class is part of the UserInterface class, i.e. all classes that are intended to interact with the user inherit the public functionality of the Plotting class.
Definition at line 61 of file plotting.hpp.
Default constructor.
Definition at line 47 of file acado/user_interaction/plotting.cpp.
Plotting::Plotting | ( | const Plotting & | rhs | ) |
Copy constructor (deep copy).
[in] | rhs | Right-hand side object. |
Definition at line 52 of file acado/user_interaction/plotting.cpp.
Plotting::~Plotting | ( | ) | [virtual] |
Destructor.
Definition at line 58 of file acado/user_interaction/plotting.cpp.
int Plotting::addPlotWindow | ( | PlotWindow & | _window | ) | [inline] |
Adds a window to the plot collection.
[in] | _window | Window to be added. |
Reimplemented in UserInteraction.
uint Plotting::getNumPlotWindows | ( | ) | const [inline] |
Returns number of windows contained in the plot collection.
returnValue Plotting::getPlotDataFromMemberLoggings | ( | PlotWindow & | _window | ) | const [protected, virtual] |
Copies all collected logging information required to plot a given window.
[in] | _window | Window to be plotted. |
Reimplemented in UserInteraction.
Definition at line 128 of file acado/user_interaction/plotting.cpp.
returnValue Plotting::getPlotWindow | ( | uint | idx, |
PlotWindow & | _window | ||
) | const [inline] |
Returns the window with given index from the plot collection.
[in] | idx | Index of desired window. |
[out] | _window | Desired window. |
returnValue Plotting::getPlotWindow | ( | PlotWindow & | _window | ) | const [inline] |
Returns the window with certain index from the plot collection. This index is not provided when calling the function, but rather obtained by using the alias index of the window. If the window is no alias window, the error RET_INDEX_OUT_OF_BOUNDS is thrown.
[out] | _window | Desired window. |
int Plotting::operator<< | ( | PlotWindow & | _window | ) | [inline] |
Adds a window to the plot collection.
[in] | _window | Window to be added. |
Reimplemented in UserInteraction.
Assignment operator (deep copy).
[in] | rhs | Right-hand side object. |
Definition at line 63 of file acado/user_interaction/plotting.cpp.
returnValue Plotting::plot | ( | PlotFrequency | _frequency = PLOT_IN_ANY_CASE | ) | [virtual] |
Plots all windows of the plot collection, each one into a new figure.
[in] | _frequency | Frequency determining at which time instants the window is to be plotted. |
Definition at line 74 of file acado/user_interaction/plotting.cpp.
returnValue Plotting::replot | ( | PlotFrequency | _frequency = PLOT_IN_ANY_CASE | ) | [virtual] |
Plots all windows of the plot collection, each one into the corresponding existing figure, if possible.
[in] | _frequency | Frequency determining at which time instants the window is to be plotted. |
Reimplemented in Process.
Definition at line 98 of file acado/user_interaction/plotting.cpp.
friend class AlgorithmicBase [friend] |
Definition at line 63 of file plotting.hpp.
PlotCollection Plotting::plotCollection [protected] |
Plot collection containing a singly-linked list of plot windows.
Definition at line 194 of file plotting.hpp.