Base class for building-blocks of the SimulationEnvironment. More...

#include <simulation_block.hpp>

Inheritance diagram for SimulationBlock:

[legend]

Public Member Functions
BlockName	getName () const

double	getSamplingTime () const

BooleanType	isDefined () const

SimulationBlock &	operator= (const SimulationBlock &rhs)

returnValue	setName (BlockName _name)

returnValue	setSamplingTime (double _samplingTime)

	SimulationBlock ()

	SimulationBlock (BlockName _name, double _samplingTime=DEFAULT_SAMPLING_TIME)

	SimulationBlock (const SimulationBlock &rhs)

virtual	~SimulationBlock ()

Public Member Functions inherited from UserInteraction
virtual int	addPlotWindow (PlotWindow &_window)

virtual int	operator<< (PlotWindow &_window)

virtual int	operator<< (LogRecord &_record)

UserInteraction &	operator= (const UserInteraction &rhs)

	UserInteraction ()

	UserInteraction (const UserInteraction &rhs)

virtual	~UserInteraction ()

Public Member Functions inherited from Options
returnValue	addOptionsList ()

returnValue	ensureConsistency ()

returnValue	ensureConsistency ()

returnValue	get (OptionsName name, int &value) const

returnValue	get (OptionsName name, double &value) const

returnValue	get (OptionsName name, std::string &value) const

returnValue	get (uint idx, OptionsName name, int &value) const

returnValue	get (uint idx, OptionsName name, double &value) const

returnValue	get (uint idx, OptionsName name, std::string &value) const

uint	getNumOptionsLists () const

Options	getOptions (uint idx) const

Options &	operator= (const Options &rhs)

Options &	operator= (const Options &rhs)

	Options ()

	Options ()

	Options (const Options &rhs)

	Options (const Options &rhs)

	Options ()

	Options (const OptionsList &_optionsList)

returnValue	print () const

returnValue	print () const

returnValue	printOptionsList () const

returnValue	printOptionsList (uint idx) const

returnValue	set (OptionsName name, int value)

returnValue	set (OptionsName name, double value)

returnValue	set (OptionsName name, const std::string &value)

returnValue	set (uint idx, OptionsName name, int value)

returnValue	set (uint idx, OptionsName name, double value)

returnValue	set (uint idx, OptionsName name, const std::string &value)

returnValue	setOptions (const Options &arg)

returnValue	setOptions (uint idx, const Options &arg)

returnValue	setToDefault ()

returnValue	setToDefault ()

returnValue	setToFast ()

returnValue	setToFast ()

returnValue	setToMPC ()

returnValue	setToReliable ()

returnValue	setToReliable ()

	~Options ()

	~Options ()

virtual	~Options ()

Public Member Functions inherited from Logging
int	addLogRecord (LogRecord &record)

returnValue	getAll (LogName _name, MatrixVariablesGrid &values) const

returnValue	getFirst (LogName _name, DMatrix &firstValue) const

returnValue	getFirst (LogName _name, VariablesGrid &firstValue) const

returnValue	getLast (LogName _name, DMatrix &lastValue) const

returnValue	getLast (LogName _name, VariablesGrid &lastValue) const

returnValue	getLogRecord (LogRecord &_record) const

uint	getNumLogRecords () const

	Logging ()

int	operator<< (LogRecord &record)

returnValue	printLoggingInfo () const

returnValue	printNumDoubles () const

returnValue	setAll (LogName _name, const MatrixVariablesGrid &values)

returnValue	setLast (LogName _name, const DMatrix &value, double time=-INFTY)

returnValue	setLast (LogName _name, VariablesGrid &value, double time=-INFTY)

returnValue	updateLogRecord (LogRecord &_record) const

virtual	~Logging ()

Public Member Functions inherited from Plotting
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 Attributes
BlockName	name

RealClock	realClock

double	samplingTime

Protected Attributes inherited from UserInteraction
BlockStatus	status

Protected Attributes inherited from Options
std::vector< OptionsList >	lists

Protected Attributes inherited from Logging
std::vector< LogRecord >	logCollection

int	logIdx

Protected Attributes inherited from Plotting
PlotCollection	plotCollection

Additional Inherited Members
Public Attributes inherited from Options
real_t	boundRelaxation

real_t	boundTolerance

int	dropBoundPriority

int_t	dropBoundPriority

int	dropEqConPriority

int_t	dropEqConPriority

int	dropIneqConPriority

int_t	dropIneqConPriority

int	enableCholeskyRefactorisation

int_t	enableCholeskyRefactorisation

int	enableDriftCorrection

int_t	enableDriftCorrection

BooleanType	enableDropInfeasibles

BooleanType	enableEqualities

BooleanType	enableFarBounds

BooleanType	enableFlippingBounds

BooleanType	enableFullLITests

BooleanType	enableInertiaCorrection

BooleanType	enableNZCTests

BooleanType	enableRamping

BooleanType	enableRegularisation

real_t	epsDen

real_t	epsFlipping

real_t	epsIterRef

real_t	epsLITests

real_t	epsNum

real_t	epsNZCTests

real_t	epsRegularisation

real_t	finalRamping

real_t	growFarBounds

real_t	initialFarBounds

real_t	initialRamping

SubjectToStatus	initialStatusBounds

real_t	maxDualJump

real_t	maxPrimalJump

int	numRefinementSteps

int_t	numRefinementSteps

int	numRegularisationSteps

int_t	numRegularisationSteps

PrintLevel	printLevel

real_t	rcondSMin

real_t	terminationTolerance

Protected Member Functions inherited from UserInteraction
virtual returnValue	getPlotDataFromMemberLoggings (PlotWindow &_window) const

BlockStatus	getStatus () const

returnValue	setStatus (BlockStatus _status)

Protected Member Functions inherited from Options
returnValue	addOption (OptionsName name, int value)

returnValue	addOption (OptionsName name, double value)

returnValue	addOption (OptionsName name, const std::string &value)

returnValue	addOption (uint idx, OptionsName name, int value)

returnValue	addOption (uint idx, OptionsName name, double value)

returnValue	addOption (uint idx, OptionsName name, const std::string &value)

returnValue	clearOptionsList ()

returnValue	copy (const Options &rhs)

returnValue	copy (const Options &rhs)

returnValue	declareOptionsUnchanged ()

returnValue	declareOptionsUnchanged (uint idx)

BooleanType	haveOptionsChanged () const

BooleanType	haveOptionsChanged (uint idx) const

virtual returnValue	setupOptions ()

Protected Member Functions inherited from Logging
virtual returnValue	setupLogging ()

Detailed Description

Base class for building-blocks of the SimulationEnvironment.

The class SimulationBlock serves as base class for all building-blocks of the SimulationEnvironment. All common functionality, like storing of the sampling time, should be collected here.

Author: Hans Joachim Ferreau, Boris Houska

Definition at line 56 of file simulation_block.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO SimulationBlock::SimulationBlock ( )

Default constructor.

Definition at line 41 of file simulation_block.cpp.

SimulationBlock::SimulationBlock	(	BlockName	_name,
		double	_samplingTime = `DEFAULT_SAMPLING_TIME`
	)

Constructor which takes the name of the block and the sampling time.

@param[in] _name                    Name of the block, see documentation of BlockName for details.
@param[in] _samplingTime    Sampling time of the block (has to be positive).

Definition at line 48 of file simulation_block.cpp.

SimulationBlock::SimulationBlock ( const SimulationBlock & rhs )

Copy constructor (deep copy).

@param[in] rhs      Right-hand side object.

Definition at line 57 of file simulation_block.cpp.

SimulationBlock::~SimulationBlock ( )

virtual

Destructor.

Definition at line 65 of file simulation_block.cpp.

Member Function Documentation

BlockName SimulationBlock::getName ( ) const

inline

Returns name of the block.

Returns: Name of the block

double SimulationBlock::getSamplingTime ( ) const

inline

Returns sampling time of the block.

Returns: Sampling time of the block

BooleanType SimulationBlock::isDefined ( ) const

inline

Returns whether the block has been defined (i.e. setup properly).

Returns: BT_TRUE iff block has been defined,
BT_FALSE otherwise

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

Assignment Operator (deep copy).

@param[in] rhs      Right-hand side object.

Definition at line 70 of file simulation_block.cpp.

returnValue SimulationBlock::setName ( BlockName _name )

inline

Assigns new name to the block.

@param[in]  _name                   New name.

Returns: SUCCESSFUL_RETURN

returnValue SimulationBlock::setSamplingTime ( double _samplingTime )

inline

Assigns new sampling time to the block.

@param[in]  _samplingTime   New sampling time.

Returns: SUCCESSFUL_RETURN,
RET_INVALID_ARGUMENTS

Member Data Documentation

BlockName SimulationBlock::name

protected

Name of the block, see documentation of BlockName for details.

Definition at line 146 of file simulation_block.hpp.

RealClock SimulationBlock::realClock

protected

Clock for real time measurements to be optionally used in derived classes.

Definition at line 149 of file simulation_block.hpp.

double SimulationBlock::samplingTime

protected

Sampling time of the block.

Definition at line 147 of file simulation_block.hpp.

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation