ACADO Toolkit  1.2.0beta
Toolkit for Automatic Control and Dynamic Optimization
Public Member Functions | Protected Member Functions | Protected Attributes

Encapsulates all user interaction for setting options, logging data and plotting results. More...

#include <user_interaction.hpp>

Inheritance diagram for UserInteraction:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 UserInteraction ()
 Default constructor.
 UserInteraction (const UserInteraction &rhs)
 Copy constructor (deep copy).
virtual ~UserInteraction ()
 Destructor.
UserInteractionoperator= (const UserInteraction &rhs)
 Assignment operator (deep copy).
virtual int operator<< (PlotWindow &_window)
 Adds a window to the plot collection.
virtual int addPlotWindow (PlotWindow &_window)
 Adds a window to the plot collection.
virtual int operator<< (LogRecord &_record)
 Adds a record to the log collection.
returnValue addOptionsList ()
 Adds an additional OptionsList to internal array.
returnValue get (OptionsName name, int &value) const
 Returns value of an existing option item of integer type.
returnValue get (OptionsName name, double &value) const
 Returns value of an existing option item of double type.
returnValue get (uint idx, OptionsName name, int &value) const
 Returns value of an existing option item of integer type within the option list of given index.
returnValue get (uint idx, OptionsName name, double &value) const
 Returns value of an existing option item of double type within the option list of given index.
returnValue set (OptionsName name, int value)
 Sets value of an existing option item of integer type to a given value.
returnValue set (OptionsName name, double value)
 Sets value of an existing option item of double type to a given value.
returnValue set (uint idx, OptionsName name, int value)
 Sets value of an existing option item of integer type within the option list of given index to a given value.
returnValue set (uint idx, OptionsName name, double value)
 Sets value of an existing option item of double type within the option list of given index to a given value.
returnValue setOptions (const Options &arg)
 Assigns a given Options object to this object.
returnValue setOptions (uint idx, const Options &arg)
 Assigns the option list with given index of a given Options object to option list with given index of this object.
Options getOptions (uint idx) const
 Returns an Options object containing exactly the option list with given index.
uint getNumOptionsLists () const
 Returns total number of option lists.
returnValue printOptionsList () const
 Prints a list of all available options of all option lists.
returnValue printOptionsList (uint idx) const
 Prints a list of all available options of option list with given index.
int addLogRecord (LogRecord &record)
 Adds a record to the log collection.
returnValue getLogRecord (uint idx, LogRecord &_record) const
 Returns the record with given index from the log collection.
returnValue getLogRecord (LogRecord &_record) const
 Returns the record with certain index from the log collection.
returnValue updateLogRecord (LogRecord &_record) const
 Updates all items with the record given as argument.
returnValue getAll (LogName _name, MatrixVariablesGrid &values) const
 Gets all numerical values at all time instants of the item with given name.
returnValue getFirst (LogName _name, Matrix &firstValue) const
 Gets numerical value at first time instant of the item with given name.
returnValue getFirst (LogName _name, VariablesGrid &firstValue) const
 Gets numerical value at first time instant of the item with given name (converts internally used Matrix into VariablesGrid).
returnValue getLast (LogName _name, Matrix &lastValue) const
 Gets numerical value at last time instant of the item with given name.
returnValue getLast (LogName _name, VariablesGrid &lastValue) const
 Gets numerical value at last time instant of the item with given name (converts internally used Matrix into VariablesGrid).
uint getNumLogRecords () const
 Returns number of records contained in the log collection.
returnValue printLoggingInfo () const
 Prints information on all records and their items on screen.
returnValue printNumDoubles () const
returnValue getPlotWindow (uint idx, PlotWindow &_window) const
 Returns the window with given index from the plot collection.
returnValue getPlotWindow (PlotWindow &_window) const
 Returns the window with certain index from the plot collection.
virtual returnValue plot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
 Plots all windows of the plot collection, each one into a new figure.
virtual returnValue replot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
 Plots all windows of the plot collection, each one into the corresponding existing figure, if possible.
uint getNumPlotWindows () const
 Returns number of windows contained in the plot collection.

Protected Member Functions

virtual returnValue getPlotDataFromMemberLoggings (PlotWindow &_window) const
 Copies all collected logging information required to plot a given window.
BlockStatus getStatus () const
 Gets current status of user interface.
returnValue setStatus (BlockStatus _status)
 Sets status of user interface.
virtual returnValue setupOptions ()
 Prototype member function for setting-up the option list(s) at initialization of derived classes.
returnValue clearOptionsList ()
 Clears all option lists from array.
BooleanType haveOptionsChanged () const
 Determines whether options of at least one option list have been modified.
BooleanType haveOptionsChanged (uint idx) const
 Determines whether options of option list with given index have been modified.
returnValue declareOptionsUnchanged ()
 Declares all options of all option lists to be unchanged.
returnValue declareOptionsUnchanged (uint idx)
 Declares all options of option list with given index to be unchanged.
returnValue addOption (OptionsName name, int value)
 Add an option item with a given integer default value to the all option lists.
returnValue addOption (OptionsName name, double value)
 Add an option item with a given double default value to the all option lists.
returnValue addOption (uint idx, OptionsName name, int value)
 Add an option item with a given integer default value to option list with given index.
returnValue addOption (uint idx, OptionsName name, double value)
 Add an option item with a given double default value to option list with given index.
virtual returnValue setupLogging ()
 Prototype member function for setting-up the logging information at initialization of derived classes.

Protected Attributes

BlockStatus status
 Current status of the user interface, see documentation of BlockStatus for details.
OptionsList ** optionsList
 Array consisting of OptionsLists.
uint nOptionsList
 Total number of OptionsLists.
LogCollection logCollection
 Log collection containing a singly-linked list of log records.
int logIdx
 Index of a certain log record to be optionally used within derived classes.
PlotCollection plotCollection
 Plot collection containing a singly-linked list of plot windows.

Detailed Description

The class UserInteraction encapsulates all user interaction for setting options, logging data and plotting results.

Author:
Hans Joachim Ferreau, Boris Houska

Constructor & Destructor Documentation

References BS_UNDEFINED, and setStatus().

Parameters:
[in]rhsRight-hand side object.

References setStatus(), and status.


Member Function Documentation

int Logging::addLogRecord ( LogRecord record) [inherited]
Parameters:
[in]recordRecord to be added.
Returns:
>= 0: index of added record,
-RET_LOG_COLLECTION_CORRUPTED

References LogCollection::addLogRecord(), and Logging::logCollection.

Referenced by AlgorithmicBase::addLogRecord(), addPlotWindow(), Logging::operator<<(), IntegrationAlgorithm::setupLogging(), Controller::setupLogging(), and Process::setupLogging().

returnValue Options::addOption ( OptionsName  name,
int  value 
) [protected, inherited]
returnValue Options::addOption ( OptionsName  name,
double  value 
) [protected, inherited]
Parameters:
[in]nameName of new option item.
[in]valueDefault value of new option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_ALREADY_EXISTS,
RET_OPTIONS_LIST_CORRUPTED

References OptionsList::add(), Options::getNumOptionsLists(), Options::optionsList, SUCCESSFUL_RETURN, and uint.

returnValue Options::addOption ( uint  idx,
OptionsName  name,
int  value 
) [protected, inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of new option item.
[in]valueDefault value of new option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_ALREADY_EXISTS,
RET_OPTIONS_LIST_CORRUPTED,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, OptionsList::add(), Options::getNumOptionsLists(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

returnValue Options::addOption ( uint  idx,
OptionsName  name,
double  value 
) [protected, inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of new option item.
[in]valueDefault value of new option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_ALREADY_EXISTS,
RET_OPTIONS_LIST_CORRUPTED,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, OptionsList::add(), Options::getNumOptionsLists(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

Returns:
SUCCESSFUL_RETURN

References Options::nOptionsList, Options::optionsList, and SUCCESSFUL_RETURN.

Referenced by AlgorithmicBase::addOptionsList().

int UserInteraction::addPlotWindow ( PlotWindow _window) [virtual]

This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.

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

Reimplemented from Plotting.

References Logging::addLogRecord(), PlotWindow::getPlotDataRecord(), and PlotWindow::setPlotDataRecord().

Referenced by operator<<().

returnValue Options::clearOptionsList ( ) [protected, inherited]
returnValue Options::declareOptionsUnchanged ( ) [protected, inherited]
returnValue Options::declareOptionsUnchanged ( uint  idx) [protected, inherited]
Parameters:
[in]idxIndex of option list.
Returns:
SUCCESSFUL_RETURN

References ACADOERROR, OptionsList::declareOptionsUnchanged(), Options::getNumOptionsLists(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

returnValue Options::get ( OptionsName  name,
int &  value 
) const [inherited]
returnValue Options::get ( OptionsName  name,
double &  value 
) const [inherited]
Parameters:
[in]nameName of option item.
[out]valueValue of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS

References OptionsList::get(), and Options::optionsList.

returnValue Options::get ( uint  idx,
OptionsName  name,
int &  value 
) const [inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of option item.
[out]valueValue of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, OptionsList::get(), Options::getNumOptionsLists(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

returnValue Options::get ( uint  idx,
OptionsName  name,
double &  value 
) const [inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of option item.
[out]valueValue of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, OptionsList::get(), Options::getNumOptionsLists(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

BEGIN_NAMESPACE_ACADO returnValue Logging::getAll ( LogName  _name,
MatrixVariablesGrid values 
) const [inline, inherited]

If this item exists in more than one record, the first one is choosen as they are expected to have identical values anyhow.

Parameters:
[in]_nameInternal name of item.
[out]valuesAll numerical values at all time instants of given item.
Returns:
SUCCESSFUL_RETURN,
RET_LOG_ENTRY_DOESNT_EXIST

References ACADOERROR, BT_TRUE, LogCollection::getAll(), LogCollection::hasNonEmptyItem(), Logging::logCollection, and RET_LOG_ENTRY_DOESNT_EXIST.

Referenced by AlgorithmicBase::getAll(), SimulationEnvironment::getProcessAlgebraicStates(), SimulationEnvironment::getProcessDifferentialStates(), and SimulationEnvironment::getProcessIntermediateStates().

returnValue Logging::getFirst ( LogName  _name,
Matrix firstValue 
) const [inline, inherited]

If this item exists in more than one record, the first one is choosen as they are expected to have identical values anyhow.

Parameters:
[in]_nameInternal name of item.
[out]firstValueNumerical value at first time instant of given item.
Returns:
SUCCESSFUL_RETURN,
RET_LOG_ENTRY_DOESNT_EXIST

References ACADOERROR, BT_TRUE, LogCollection::getFirst(), LogCollection::hasNonEmptyItem(), Logging::logCollection, and RET_LOG_ENTRY_DOESNT_EXIST.

Referenced by AlgorithmicBase::getFirst().

returnValue Logging::getFirst ( LogName  _name,
VariablesGrid firstValue 
) const [inline, inherited]

If this item exists in more than one record, the first one is choosen as they are expected to have identical values anyhow.

Parameters:
[in]_nameInternal name of item.
[out]firstValueNumerical value at first time instant of given item.
Returns:
SUCCESSFUL_RETURN,
RET_LOG_ENTRY_DOESNT_EXIST

References ACADOERROR, BT_TRUE, LogCollection::getFirst(), LogCollection::hasNonEmptyItem(), Logging::logCollection, and RET_LOG_ENTRY_DOESNT_EXIST.

returnValue Logging::getLast ( LogName  _name,
Matrix lastValue 
) const [inline, inherited]

If this item exists in more than one record, the first one is choosen as they are expected to have identical values anyhow.

Parameters:
[in]_nameInternal name of item.
[out]lastValueNumerical value at last time instant of given item.
Returns:
SUCCESSFUL_RETURN,
RET_LOG_ENTRY_DOESNT_EXIST

References ACADOERROR, BT_TRUE, LogCollection::getLast(), LogCollection::hasNonEmptyItem(), Logging::logCollection, and RET_LOG_ENTRY_DOESNT_EXIST.

Referenced by AlgorithmicBase::getLast().

returnValue Logging::getLast ( LogName  _name,
VariablesGrid lastValue 
) const [inline, inherited]

If this item exists in more than one record, the first one is choosen as they are expected to have identical values anyhow.

Parameters:
[in]_nameInternal name of item.
[out]lastValueNumerical value at last time instant of given item.
Returns:
SUCCESSFUL_RETURN,
RET_LOG_ENTRY_DOESNT_EXIST

References ACADOERROR, BT_TRUE, LogCollection::getLast(), LogCollection::hasNonEmptyItem(), Logging::logCollection, and RET_LOG_ENTRY_DOESNT_EXIST.

returnValue Logging::getLogRecord ( uint  idx,
LogRecord _record 
) const [inherited]
Parameters:
[in]idxIndex of desired record.
[out]_recordDesired record.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, Logging::getNumLogRecords(), Logging::logCollection, RET_INDEX_OUT_OF_BOUNDS, and SUCCESSFUL_RETURN.

Referenced by Logging::getLogRecord().

returnValue Logging::getLogRecord ( LogRecord _record) const [inherited]

This index is not provided when calling the function, but rather obtained by using the alias index of the record. If the record is no alias record, the error RET_INDEX_OUT_OF_BOUNDS is thrown.

Parameters:
[out]_recordDesired record.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

References LogRecord::getAliasIdx(), and Logging::getLogRecord().

uint Logging::getNumLogRecords ( ) const [inherited]
Returns:
Number of records

References LogCollection::getNumLogRecords(), and Logging::logCollection.

Referenced by Logging::getLogRecord().

uint Plotting::getNumPlotWindows ( ) const [inline, inherited]
Returns:
Number of windows

References PlotCollection::getNumPlotWindows(), and Plotting::plotCollection.

Referenced by Plotting::getPlotWindow().

Options Options::getOptions ( uint  idx) const [inherited]
Parameters:
[in]idxIndex of option list.
Returns:
Options object containing exactly the option list with given index

References ACADOERROR, Options::getNumOptionsLists(), Options::Options(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

Referenced by AlgorithmicBase::getOptions().

returnValue UserInteraction::getPlotDataFromMemberLoggings ( PlotWindow _window) const [protected, virtual]

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.

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

Reimplemented from Plotting.

References PlotWindow::getPlotDataRecord(), PlotWindow::setPlotDataRecord(), SUCCESSFUL_RETURN, and Logging::updateLogRecord().

returnValue Plotting::getPlotWindow ( uint  idx,
PlotWindow _window 
) const [inline, inherited]
Parameters:
[in]idxIndex of desired window.
[out]_windowDesired window.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, Plotting::getNumPlotWindows(), Plotting::getPlotDataFromMemberLoggings(), Plotting::plotCollection, and RET_INDEX_OUT_OF_BOUNDS.

Referenced by Plotting::getPlotWindow(), Plotting::plot(), and Plotting::replot().

returnValue Plotting::getPlotWindow ( PlotWindow _window) const [inline, inherited]

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]_windowDesired window.
Returns:
SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

References PlotWindow::getAliasIdx(), and Plotting::getPlotWindow().

BlockStatus UserInteraction::getStatus ( ) const [protected]
BooleanType Options::haveOptionsChanged ( ) const [protected, inherited]
BooleanType Options::haveOptionsChanged ( uint  idx) const [protected, inherited]
Parameters:
[in]idxIndex of option list.
Returns:
BT_TRUE iff options have been modified,
BT_FALSE otherwise

References ACADOERROR, BT_FALSE, Options::getNumOptionsLists(), OptionsList::haveOptionsChanged(), Options::optionsList, and RET_INDEX_OUT_OF_BOUNDS.

int UserInteraction::operator<< ( PlotWindow _window) [virtual]

This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.

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 record,
-RET_PLOT_COLLECTION_CORRUPTED

Reimplemented from Plotting.

References addPlotWindow().

Referenced by operator<<().

int UserInteraction::operator<< ( LogRecord _record) [virtual]
Parameters:
[in]recordRecord to be added.
Note:
This function tunnels the corresponding function of the Logging class. It is introduced to avoid syntax ambiguity only.
Returns:
>= 0: index of added record,
-RET_LOG_COLLECTION_CORRUPTED

Reimplemented from Logging.

References operator<<().

UserInteraction & UserInteraction::operator= ( const UserInteraction rhs)
Parameters:
[in]rhsRight-hand side object.

References setStatus(), and status.

returnValue Plotting::plot ( PlotFrequency  _frequency = PLOT_IN_ANY_CASE) [virtual, inherited]
Parameters:
[in]_frequencyFrequency determining at which time instants the window is to be plotted.
Returns:
SUCCESSFUL_RETURN

References ACADOERROR, PlotCollection::first, PlotWindow::getNext(), Plotting::getPlotWindow(), PlotWindow::plot(), PLOT_NEVER, Plotting::plotCollection, RET_PLOTTING_FAILED, and SUCCESSFUL_RETURN.

Referenced by IntegrationAlgorithm::evaluate(), and AlgorithmicBase::plot().

returnValue Logging::printLoggingInfo ( ) const [inherited]
returnValue Logging::printNumDoubles ( ) const [inherited]
returnValue Options::printOptionsList ( ) const [inherited]
returnValue Options::printOptionsList ( uint  idx) const [inherited]
Parameters:
[in]idxIndex of option list.
Returns:
SUCCESSFUL_RETURN

References ACADOERROR, Options::getNumOptionsLists(), Options::optionsList, OptionsList::printOptionsList(), and RET_INDEX_OUT_OF_BOUNDS.

returnValue Plotting::replot ( PlotFrequency  _frequency = PLOT_IN_ANY_CASE) [virtual, inherited]
Parameters:
[in]_frequencyFrequency determining at which time instants the window is to be plotted.
Returns:
SUCCESSFUL_RETURN

Reimplemented in Process.

References ACADOERROR, PlotCollection::first, PlotWindow::getNext(), Plotting::getPlotWindow(), PLOT_NEVER, Plotting::plotCollection, PlotWindow::replot(), RET_PLOTTING_FAILED, and SUCCESSFUL_RETURN.

Referenced by AlgorithmicBase::replot(), and RealTimeAlgorithm::solve().

returnValue Options::set ( OptionsName  name,
int  value 
) [inherited]
Parameters:
[in]nameName of option item.
[in]valueNew value of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_OPTIONS_LIST_CORRUPTED

References Options::optionsList, and OptionsList::set().

Referenced by AlgorithmicBase::set().

returnValue Options::set ( OptionsName  name,
double  value 
) [inherited]
Parameters:
[in]nameName of option item.
[in]valueNew value of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_OPTIONS_LIST_CORRUPTED

References Options::optionsList, and OptionsList::set().

returnValue Options::set ( uint  idx,
OptionsName  name,
int  value 
) [inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of option item.
[in]valueNew value of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_OPTIONS_LIST_CORRUPTED,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, Options::getNumOptionsLists(), Options::optionsList, RET_INDEX_OUT_OF_BOUNDS, and OptionsList::set().

returnValue Options::set ( uint  idx,
OptionsName  name,
double  value 
) [inherited]
Parameters:
[in]idxIndex of option list.
[in]nameName of option item.
[in]valueNew value of option.
Returns:
SUCCESSFUL_RETURN,
RET_OPTION_DOESNT_EXISTS,
RET_OPTIONS_LIST_CORRUPTED,
RET_INDEX_OUT_OF_BOUNDS

References ACADOERROR, Options::getNumOptionsLists(), Options::optionsList, RET_INDEX_OUT_OF_BOUNDS, and OptionsList::set().

returnValue Options::setOptions ( const Options arg) [inherited]
Parameters:
[in]argNew Options object to be assigned.
Note:
This routine is introduced only for convenience and is equivalent to the assignment operator.
Returns:
SUCCESSFUL_RETURN

References Options::operator=(), and SUCCESSFUL_RETURN.

Referenced by AlgorithmicBase::setOptions().

returnValue Options::setOptions ( uint  idx,
const Options arg 
) [inherited]
Parameters:
[in]idxIndex of option list.
[in]argOptions object containing the option list to be assigned.
Returns:
SUCCESSFUL_RETURN

References ACADOERROR, Options::getNumOptionsLists(), Options::optionsList, RET_INDEX_OUT_OF_BOUNDS, and SUCCESSFUL_RETURN.

Parameters:
[in]_statusNew status of user interface
Returns:
SUCCESSFUL_RETURN

References status, and SUCCESSFUL_RETURN.

Referenced by Controller::Controller(), DynamicEstimator::DynamicEstimator(), Estimator::Estimator(), FeedforwardLaw::FeedforwardLaw(), KalmanFilter::init(), OptimizationAlgorithm::init(), DynamicEstimator::init(), Estimator::init(), LinearStateFeedback::init(), FeedforwardLaw::init(), RealTimeAlgorithm::init(), TransferDevice::init(), PIDcontroller::init(), SimulationEnvironment::init(), Controller::init(), Process::init(), Process::initializeStartValues(), IntegrationAlgorithm::IntegrationAlgorithm(), KalmanFilter::KalmanFilter(), LinearStateFeedback::LinearStateFeedback(), OCPexport::OCPexport(), operator=(), OptimizationAlgorithm::OptimizationAlgorithm(), RealTimeAlgorithm::performFeedbackStep(), RealTimeAlgorithm::performPreparationStep(), PIDcontroller::PIDcontroller(), Process::Process(), RealTimeAlgorithm::RealTimeAlgorithm(), Process::setActuator(), Controller::setControlLaw(), SimulationEnvironment::setController(), Process::setDynamicSystem(), Controller::setEstimator(), SimulationEnvironment::setProcess(), Process::setProcessDisturbance(), Controller::setReferenceTrajectory(), Process::setSensor(), OCPexport::setup(), SIMexport::setup(), SIMexport::SIMexport(), SimulationEnvironment::SimulationEnvironment(), MultiObjectiveAlgorithm::solve(), MultiObjectiveAlgorithm::solveSingleObjective(), TransferDevice::TransferDevice(), and UserInteraction().

returnValue Logging::setupLogging ( ) [protected, virtual, inherited]
returnValue Options::setupOptions ( ) [protected, virtual, inherited]
returnValue Logging::updateLogRecord ( LogRecord _record) const [inherited]

In doing so, it is checked for each item whether it is contained within one of of the records of the collection; and if so, the numerical values are copied into the argument record.

Parameters:
[in,out]_recordRecord to be updated
Returns:
SUCCESSFUL_RETURN

References Logging::logCollection, and LogCollection::updateLogRecord().

Referenced by getPlotDataFromMemberLoggings(), and SimulationEnvironment::getSampledProcessOutput().


Member Data Documentation

LogCollection Logging::logCollection [protected, inherited]
int Logging::logIdx [protected, inherited]
uint Options::nOptionsList [protected, inherited]
OptionsList** Options::optionsList [protected, inherited]
PlotCollection Plotting::plotCollection [protected, inherited]

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines