Public Member Functions | Protected Member Functions | Protected Attributes | Friends

Allows to setup and plot user-specified plot windows for algorithmic outputs. More...

#include <plot_window.hpp>

Inheritance diagram for PlotWindow:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual returnValue addData (uint idx, const VariablesGrid &_newData)
virtual returnValue addLine (uint idx, double _lineValue)
returnValue addSubplot (PlotWindowSubplot &_subplot)
returnValue addSubplot (const Expression &_expression, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _xRangeLowerLimit=INFTY, double _xRangeUpperLimit=INFTY, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue addSubplot (const Expression &_expressionX, const Expression &_expressionY, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _xRangeLowerLimit=INFTY, double _xRangeUpperLimit=INFTY, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue addSubplot (PlotName _name, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _xRangeLowerLimit=INFTY, double _xRangeUpperLimit=INFTY, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue addSubplot (const VariablesGrid &_variable, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _xRangeLowerLimit=INFTY, double _xRangeUpperLimit=INFTY, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue addSubplot (const Curve &_curve, double _xRangeLowerLimit=0.0, double _xRangeUpperLimit=1.0, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue addSubplot3D (const VariablesGrid &_variable, const char *const _title="", const char *const _xLabel="", const char *const _yLabel="", PlotMode _plotMode=PM_UNKNOWN, double _xRangeLowerLimit=INFTY, double _xRangeUpperLimit=INFTY, double _yRangeLowerLimit=INFTY, double _yRangeUpperLimit=INFTY)
returnValue clearAllSubplots ()
virtual PlotWindowclone () const
int getAliasIdx () const
uint getNumSubplots () const
returnValue getPlotDataRecord (LogRecord &_record) const
PlotFrequency getPlotFrequency () const
virtual returnValue init ()
BooleanType isAlias () const
BooleanType isEmpty () const
PlotWindowSubplotoperator() (uint idx)
PlotWindowSubplot operator() (uint idx) const
returnValue operator<< (PlotWindowSubplot &_subplot)
returnValue operator<< (PlotName _name)
returnValue operator<< (const Expression &_name)
PlotWindowoperator= (const PlotWindow &rhs)
virtual returnValue plot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
 PlotWindow ()
 PlotWindow (PlotFrequency _frequency)
 PlotWindow (const PlotWindow &rhs)
virtual returnValue replot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
virtual returnValue setLabelX (uint idx, const char *const xLabel_)
virtual returnValue setLabelY (uint idx, const char *const yLabel_)
returnValue setPlotData (const Expression &_name, VariablesGrid &value)
returnValue setPlotData (LogName _name, VariablesGrid &value)
returnValue setPlotDataRecord (LogRecord &_record)
virtual returnValue setPlotMode (uint idx, PlotMode plotMode)
virtual returnValue setRanges (uint idx, double xRange1, double xRange2, double yRange1, double yRange2)
virtual returnValue setTitle (uint idx, const char *const title_)
virtual ~PlotWindow ()

Protected Member Functions

returnValue addPlotDataItem (VariableType _type)
returnValue addPlotDataItem (const Expression *const _expression)
returnValue addPlotDataItem (PlotName _name)
PlotName convertLogToPlotName (LogName _name) const
LogName convertPlotToLogName (PlotName _name) const
returnValue disableNominalControls ()
returnValue disableNominalOutputs ()
returnValue disableNominalParameters ()
returnValue enableNominalControls ()
returnValue enableNominalOutputs ()
returnValue enableNominalParameters ()
returnValue getAutoScaleYLimits (const VariablesGrid &dataGridY, PlotFormat plotFormat, double &lowerLimit, double &upperLimit) const
returnValue getDataGrids (const VariablesGrid *const variablesGrid, VariableType &_type, VariablesGrid &_dataGrid, Grid &_discretizationGrid)
returnValue getExpressionDataGrids (const Expression *const expression, VariableType &_type, VariablesGrid &_dataGrid, Grid &_discretizationGrid)
PlotWindowgetNext () const
returnValue getVariableDataGrids (const Expression *const variable, VariableType &_type, VariablesGrid &_dataGrid, Grid &_discretizationGrid)
returnValue setAliasIdx (int _aliasIdx)
returnValue setNext (PlotWindow *const _next)
returnValue setupLogFrequency (PlotFrequency _frequency=PLOT_AT_EACH_ITERATION)

Protected Attributes

int aliasIdx
PlotWindowSubplotfirst
PlotFrequency frequency
PlotWindowSubplotlast
PlotWindownext
uint number
LogRecord plotDataRecord
BooleanType shallPlotNominalControls
BooleanType shallPlotNominalOutputs
BooleanType shallPlotNominalParameters

Friends

class PlotCollection
class Plotting

Detailed Description

Allows to setup and plot user-specified plot windows for algorithmic outputs.

The class PlotWindow allows to setup and plot user-specified plot windows for algorithmic outputs to be plotted during runtime.

A plot windows comprises arbitrarily many PlotWindowSubplots stored in a simple singly-linked list. These subplots store the information which algorithmic output is to be plotted as well as settings defining the style of the subplot. Note, however, that the actual data to be plotted is stored centrally for all subplots within the PlotWindow class for memory reasons. The data required for plotting is stored within a LogRecord.

Additionally, a plot window stores the PlotFrequency defining whether the window is to be plotted at each iteration or only at the start or end, respectively.

Finally, it is interesting to know that PlotWindows can be setup by the user and flushed to UserInterface classes. Internally, PlotWindows are stored as basic singly-linked within a PlotCollection.

Note:
The class PlotWindow is designed as non-abstract base class for interfacing different plotting routines, e.g. the interface to Gnuplot.
Author:
Hans Joachim Ferreau, Boris Houska

Definition at line 76 of file plot_window.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 47 of file plot_window.cpp.

Constructor which takes the plot frequency.

Parameters:
[in]_frequencyFrequency determining at which time instants the window is to be plotted.

Definition at line 66 of file plot_window.cpp.

Copy constructor (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 86 of file plot_window.cpp.

PlotWindow::~PlotWindow ( ) [virtual]

Destructor.

Definition at line 116 of file plot_window.cpp.


Member Function Documentation

returnValue PlotWindow::addData ( uint  idx,
const VariablesGrid _newData 
) [virtual]

Adds an additional discrete data points to be plotted within the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]_newDataAdditional discrete data points.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 243 of file plot_window.cpp.

returnValue PlotWindow::addLine ( uint  idx,
double  _lineValue 
) [virtual]

Adds an additional horizontal lines to be plotted within the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]_lineValueY-value of the additional horizontal line.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 232 of file plot_window.cpp.

Adds all log record items to internal plotDataRecord that that are required to plot variables of given type.

Parameters:
[in]_typeType of variable to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 614 of file plot_window.cpp.

returnValue PlotWindow::addPlotDataItem ( const Expression *const  _expression) [protected]

Adds all log record items to internal plotDataRecord that that are required to plot given expression.

Parameters:
[in]_expressionExpression to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 588 of file plot_window.cpp.

Adds all log record items to internal plotDataRecord that that are required to plot given pre-defined information.

Parameters:
[in]_namePre-defined information to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 663 of file plot_window.cpp.

Adds a subplot to the singly-linked list.

Parameters:
[in]_subplotSubplot to be added.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_WINDOW_CORRUPTED

Definition at line 276 of file plot_window.cpp.

returnValue PlotWindow::addSubplot ( const Expression _expression,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _xRangeLowerLimit = INFTY,
double  _xRangeUpperLimit = INFTY,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a subplot plotting the given symbolic expression to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_expressionSymbolic expression to be plotted on the y-axis.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 316 of file plot_window.cpp.

returnValue PlotWindow::addSubplot ( const Expression _expressionX,
const Expression _expressionY,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _xRangeLowerLimit = INFTY,
double  _xRangeUpperLimit = INFTY,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a subplot plotting the given symbolic expressions to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_expressionXSymbolic expression to be plotted on the x-axis.
[in]_expressionYSymbolic expression to be plotted on the y-axis.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 360 of file plot_window.cpp.

returnValue PlotWindow::addSubplot ( PlotName  _name,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _xRangeLowerLimit = INFTY,
double  _xRangeUpperLimit = INFTY,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a subplot plotting the given pre-defined information to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_nameInternal name of pre-defined information to be plotted.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 414 of file plot_window.cpp.

returnValue PlotWindow::addSubplot ( const VariablesGrid _variable,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _xRangeLowerLimit = INFTY,
double  _xRangeUpperLimit = INFTY,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a subplot plotting the given discrete data to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_variableDiscrete data to be plotted on the y-axis.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 456 of file plot_window.cpp.

returnValue PlotWindow::addSubplot ( const Curve _curve,
double  _xRangeLowerLimit = 0.0,
double  _xRangeUpperLimit = 1.0,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a subplot plotting the given curve to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_curveCurve to be plotted on the y-axis.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 526 of file plot_window.cpp.

returnValue PlotWindow::addSubplot3D ( const VariablesGrid _variable,
const char *const  _title = "",
const char *const  _xLabel = "",
const char *const  _yLabel = "",
PlotMode  _plotMode = PM_UNKNOWN,
double  _xRangeLowerLimit = INFTY,
double  _xRangeUpperLimit = INFTY,
double  _yRangeLowerLimit = INFTY,
double  _yRangeUpperLimit = INFTY 
)

Adds a 3D subplot plotting the given discrete data to the singly-linked list. In addition, title and other properties of the subplot can be specified.

Parameters:
[in]_variableDiscrete data to be plotted on the y-axis.
[in]_titleTitle of the subplot.
[in]_xLabelLabel of x-axis of the subplot.
[in]_yLabelLabel of y-axis of the subplot.
[in]_plotModePlot mode, see the PlotMode documentation for details.
[in]_xRangeLowerLimitLower limit of the x-axis.
[in]_xRangeUpperLimitUpper limit of the x-axis.
[in]_yRangeLowerLimitLower limit of the y-axis.
[in]_yRangeUpperLimitUpper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_COLLECTION_CORRUPTED,
RET_LOG_RECORD_CORRUPTED

Definition at line 491 of file plot_window.cpp.

Clears all subplots from the singly-linked list.

Returns:
SUCCESSFUL_RETURN

Definition at line 560 of file plot_window.cpp.

PlotWindow * PlotWindow::clone ( ) const [virtual]

Clone operator returning a base class pointer to a deep copy of the respective class instance.

Returns:
Base class pointer to a deep copy of respective class instance

Reimplemented in GnuplotWindow.

Definition at line 154 of file plot_window.cpp.

PlotName PlotWindow::convertLogToPlotName ( LogName  _name) const [protected]

Returns internal name of pre-defined plotting information that corresponds to given pre-defined logging information.

Parameters:
[in]_nameName of pre-defined logging information.
Returns:
Internal name of pre-defined plotting information

Definition at line 705 of file plot_window.cpp.

LogName PlotWindow::convertPlotToLogName ( PlotName  _name) const [protected]

Returns internal name of pre-defined logging information that corresponds to given pre-defined plotting information.

Parameters:
[in]_namePre-defined information to be plotted.
Returns:
Internal name of pre-defined logging information

Definition at line 678 of file plot_window.cpp.

int PlotWindow::getAliasIdx ( ) const [inline]

Returns alias index of window.

Returns:
>= 0: alias index of window,
-1: window is not an alias window
returnValue PlotWindow::getAutoScaleYLimits ( const VariablesGrid dataGridY,
PlotFormat  plotFormat,
double &  lowerLimit,
double &  upperLimit 
) const [protected]

Determines suitable range of the y-axis for plotting a given discrete data grid in an automated way.

Parameters:
[in]dataGridYDiscrete data grid to be plotted.
[in]plotFormatPlot format of data grid to be plotted.
[out]lowerLimitSuggested lower limit of the y-axis.
[out]upperLimitSuggested upper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN

Definition at line 936 of file plot_window.cpp.

returnValue PlotWindow::getDataGrids ( const VariablesGrid *const  variablesGrid,
VariableType _type,
VariablesGrid _dataGrid,
Grid _discretizationGrid 
) [protected]

Determines type and discrete plot data grid for a given data grid to be plotted.

Parameters:
[in]variableVariable to be plotted.
[out]_typeType of variable to be plotted.
[out]_dataGridDiscrete plot data grid of variable to be plotted.
[out]_discretizationGridHigher-level discretization grid of variable to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 891 of file plot_window.cpp.

returnValue PlotWindow::getExpressionDataGrids ( const Expression *const  expression,
VariableType _type,
VariablesGrid _dataGrid,
Grid _discretizationGrid 
) [protected]

Determines type, discrete plot data grid and the higher-level discretization grid for a given expression to be plotted. The last two arguments are obtained from the internal plotDataRecord.

Parameters:
[in]expressionExpression to be plotted.
[out]_typeType of variable to be plotted.
[out]_dataGridDiscrete plot data grid of variable to be plotted.
[out]_discretizationGridHigher-level discretization grid of variable to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 851 of file plot_window.cpp.

PlotWindow* PlotWindow::getNext ( ) const [inline, protected]

Returns pointer to next PlotWindow within a PlotCollection.

Returns:
Pointer to next window (or NULL iff window is terminal element).
uint PlotWindow::getNumSubplots ( ) const [inline]

Returns number of subplots contained in the window.

Returns:
Number of subplots
returnValue PlotWindow::getPlotDataRecord ( LogRecord _record) const [inline]

Returns deep-copy of internal plotDataRecord.

Parameters:
[out]_recordInternal plotDataRecord.
Returns:
SUCCESSFUL_RETURN

Returns current plot frequency determining at which time instants the window is to be plotted

Returns:
Current plot frequency
returnValue PlotWindow::getVariableDataGrids ( const Expression *const  variable,
VariableType _type,
VariablesGrid _dataGrid,
Grid _discretizationGrid 
) [protected]

Determines type, discrete plot data grid and the higher-level discretization grid for a given variable to be plotted. The last two arguments are obtained from the internal plotDataRecord.

Parameters:
[in]variableVariable to be plotted.
[out]_typeType of variable to be plotted.
[out]_dataGridDiscrete plot data grid of variable to be plotted.
[out]_discretizationGridHigher-level discretization grid of variable to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 757 of file plot_window.cpp.

Initialized the plot window.

Returns:
SUCCESSFUL_RETURN

Reimplemented in GnuplotWindow.

Definition at line 160 of file plot_window.cpp.

BooleanType PlotWindow::isAlias ( ) const [inline]

Returns whether window is an alias of another one.

Returns:
BT_TRUE iff window is an alias,
BT_FALSE otherwise
BooleanType PlotWindow::isEmpty ( ) const [inline]

Returns whether the window is empty (i.e. contains no subplots) or not.

Returns:
BT_TRUE iff window is empty,
BT_FALSE otherwise
PlotWindowSubplot& PlotWindow::operator() ( uint  idx) [inline]

Returns a subplot of the singly-linked list with given index.

Parameters:
[in]idxIndex of desired subplot.
Returns:
Subplot with given index.
PlotWindowSubplot PlotWindow::operator() ( uint  idx) const [inline]

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

Parameters:
[in]idxIndex of desired subplot.
Returns:
Subplot with given index.
returnValue PlotWindow::operator<< ( PlotWindowSubplot _subplot)

Adds a subplot to the singly-linked list.

Parameters:
[in]_subplotSubplot to be added.
Note:
This function is doing the same as the corresponding addSubplot member function and is introduced for syntax reasons only.
Returns:
SUCCESSFUL_RETURN,
RET_PLOT_WINDOW_CORRUPTED

Definition at line 255 of file plot_window.cpp.

returnValue PlotWindow::operator<< ( PlotName  _name)

Adds an subplot of given internal name to the singly-linked list.

Parameters:
[in]_nameInternal name of subplot to be added.
Note:
This function is doing the same as the corresponding addSubplot member function and is introduced for syntax reasons only.
Returns:
SUCCESSFUL_RETURN

Definition at line 262 of file plot_window.cpp.

returnValue PlotWindow::operator<< ( const Expression _name)

Adds an subplot of given internal name to the singly-linked list.

Parameters:
[in]_nameInternal name of subplot to be added.
Note:
This function is doing the same as the corresponding addSubplot member function and is introduced for syntax reasons only.
Returns:
SUCCESSFUL_RETURN

Definition at line 269 of file plot_window.cpp.

PlotWindow & PlotWindow::operator= ( const PlotWindow rhs)

Assignment operator (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 122 of file plot_window.cpp.

Plots window into a new figure.

Parameters:
[in]_frequencyFrequency determining at which time instants the window is to be plotted.
Returns:
SUCCESSFUL_RETURN

Definition at line 166 of file plot_window.cpp.

Plots window into existing figure, if possible.

Parameters:
[in]_frequencyFrequency determining at which time instants the window is to be plotted.
Returns:
SUCCESSFUL_RETURN

Reimplemented in GnuplotWindow.

Definition at line 175 of file plot_window.cpp.

returnValue PlotWindow::setAliasIdx ( int  _aliasIdx) [inline, protected]

Assigns alias index of window.

Parameters:
[in]_aliasIdxNew alias index (-1 = no alias window)
Returns:
SUCCESSFUL_RETURN
returnValue PlotWindow::setLabelX ( uint  idx,
const char *const  xLabel_ 
) [virtual]

Sets label of x-axis of the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]xLabel_New label of x-axis.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 190 of file plot_window.cpp.

returnValue PlotWindow::setLabelY ( uint  idx,
const char *const  yLabel_ 
) [virtual]

Sets label of y-axis of the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]yLabel_New label of y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 199 of file plot_window.cpp.

returnValue PlotWindow::setNext ( PlotWindow *const  _next) [inline, protected]

Assigns pointer to next PlotWindow within a PlotCollection.

Parameters:
[in]_nextNew pointer to next window.
Returns:
SUCCESSFUL_RETURN
returnValue PlotWindow::setPlotData ( const Expression _name,
VariablesGrid value 
) [inline]

Assigns numerical values of given expression/variable to internal plotDataRecord.

Parameters:
[in]_nameName of expression/variable to be plotted.
[in]valueNew numerical values in form of a discrete data grid.
Returns:
SUCCESSFUL_RETURN
returnValue PlotWindow::setPlotData ( LogName  _name,
VariablesGrid value 
) [inline]

Assigns numerical values of given pre-defined plotting information to internal plotDataRecord.

Parameters:
[in]_nameName of pre-defined information to be plotted.
[in]valueNew numerical values in form of a discrete data grid.
Returns:
SUCCESSFUL_RETURN

Assigns new internal plotDataRecord.

Parameters:
[in]_recordNew internal plotDataRecord.
Returns:
SUCCESSFUL_RETURN
returnValue PlotWindow::setPlotMode ( uint  idx,
PlotMode  plotMode 
) [virtual]

Sets plot mode of the subplot with given index, defining how the data points are to be plotted.

Parameters:
[in]idxIndex of subplot.
[in]plotModeNew plot mode, see the PlotMode documentation for details.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 208 of file plot_window.cpp.

returnValue PlotWindow::setRanges ( uint  idx,
double  xRange1,
double  xRange2,
double  yRange1,
double  yRange2 
) [virtual]

Sets ranges of the axes of the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]xRange1Lower limit of the x-axis.
[in]xRange2Upper limit of the x-axis.
[in]yRange1Lower limit of the y-axis.
[in]yRange2Upper limit of the y-axis.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS,
RET_INVALID_ARGUMENTS

Definition at line 217 of file plot_window.cpp.

returnValue PlotWindow::setTitle ( uint  idx,
const char *const  title_ 
) [virtual]

Sets title of the subplot with given index.

Parameters:
[in]idxIndex of subplot.
[in]title_New title.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 182 of file plot_window.cpp.

Sets-up log frequency that corresponds to given plot frequency determining at which time instants the window is to be plotted.

Parameters:
[in]_frequencyPlot frequency.
Returns:
SUCCESSFUL_RETURN

Definition at line 733 of file plot_window.cpp.


Friends And Related Function Documentation

friend class PlotCollection [friend]

Definition at line 78 of file plot_window.hpp.

friend class Plotting [friend]

Definition at line 79 of file plot_window.hpp.


Member Data Documentation

int PlotWindow::aliasIdx [protected]

Alias index of window (-1 = no alias window).

Definition at line 755 of file plot_window.hpp.

Pointer to first subplot of the singly-linked list.

Definition at line 759 of file plot_window.hpp.

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

Definition at line 757 of file plot_window.hpp.

Pointer to last subplot of the singly-linked list.

Definition at line 760 of file plot_window.hpp.

Pointer to next windows within a PlotCollection.

Definition at line 754 of file plot_window.hpp.

uint PlotWindow::number [protected]

Total number of subplots within the singly-linked list of the window.

Definition at line 762 of file plot_window.hpp.

LogRecord to store all data necessary for plotting the window.

Definition at line 764 of file plot_window.hpp.

Definition at line 766 of file plot_window.hpp.

Definition at line 768 of file plot_window.hpp.

Definition at line 767 of file plot_window.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