Plotting Class Reference

Provides a generic way to plot algorithmic outputs during runtime. More...

#include <plotting.hpp>

Inheritance diagram for Plotting:

List of all members.

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

---

Detailed Description

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.

Author:

Hans Joachim Ferreau, Boris Houska

Definition at line 61 of file plotting.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Plotting::Plotting

(

)

Default constructor.

Definition at line 47 of file acado/user_interaction/plotting.cpp.

Plotting::Plotting

(

const Plotting &

rhs

)

Copy constructor (deep copy).

Parameters:

[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.

---

Member Function Documentation

int Plotting::addPlotWindow

(

PlotWindow &

_window

)

[inline]

Adds a window to the plot collection.

Parameters:

[in]

_window

Window to be added.

Returns:

>= 0: index of added record,
-RET_PLOT_COLLECTION_CORRUPTED

Reimplemented in UserInteraction.

uint Plotting::getNumPlotWindows

(

)

const [inline]

Returns number of windows contained in the plot collection.

Returns:

Number of windows

returnValue Plotting::getPlotDataFromMemberLoggings

(

PlotWindow &

_window

)

const [protected, virtual]

Copies all collected logging information required to plot a given window.

Parameters:

[in]

_window

Window to be plotted.

Note:

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.

Returns:

SUCCESSFUL_RETURN

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.

Parameters:

[in]	idx	Index of desired window.
[out]	_window	Desired window.

Returns:

SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

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.

Parameters:

[out]

_window

Desired window.

Returns:

SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

int Plotting::operator<<

(

PlotWindow &

_window

)

[inline]

Adds a window to the plot 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

Reimplemented in UserInteraction.

Plotting & Plotting::operator=

(

const Plotting &

rhs

)

Assignment operator (deep copy).

Parameters:

[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.

Parameters:

[in]

_frequency

Frequency determining at which time instants the window is to be plotted.

Returns:

SUCCESSFUL_RETURN

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.

Parameters:

[in]

_frequency

Frequency determining at which time instants the window is to be plotted.

Returns:

SUCCESSFUL_RETURN

Reimplemented in Process.

Definition at line 98 of file acado/user_interaction/plotting.cpp.

---

Friends And Related Function Documentation

friend class AlgorithmicBase [friend]

Definition at line 63 of file plotting.hpp.

---

Member Data Documentation

PlotCollection Plotting::plotCollection [protected]

Plot collection containing a singly-linked list of plot windows.

Definition at line 194 of file plotting.hpp.

---

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

• plotting.hpp
• acado/user_interaction/plotting.cpp