Public Member Functions | Protected Member Functions | Protected Attributes

Base class for simulating Actuator and Sensor behaviour wihtin the Process. More...

#include <transfer_device.hpp>

Inheritance diagram for TransferDevice:
Inheritance graph
[legend]

List of all members.

Public Member Functions

uint getDim () const
BooleanType hasDeadTime () const
BooleanType hasNoise () const
BooleanType isEmpty () const
TransferDeviceoperator= (const TransferDevice &rhs)
 TransferDevice ()
 TransferDevice (uint _dim, BlockName _name=BN_DEFAULT, double _samplingTime=DEFAULT_SAMPLING_TIME)
 TransferDevice (const TransferDevice &rhs)
virtual ~TransferDevice ()

Protected Member Functions

virtual returnValue generateNoise (double startTime, double endTime, VariablesGrid &currentNoise) const
virtual returnValue init (double _startTime=0.0, const DVector &_startValue=emptyConstVector)

Protected Attributes

Noise ** additiveNoise
DVector deadTimes
VariablesGrid lastSignal
DVector noiseSamplingTimes

Detailed Description

Base class for simulating Actuator and Sensor behaviour wihtin the Process.

The class TransferDevive serves as a base class for simulating Actuator and Sensor behaviour within the Process. It is intended to collect common features of the Actuator and Sensor.

At the moment, it basically stores an array of additive noise as well as the dead times of each component. It also provides a common way to generate noise.

Author:
Hans Joachim Ferreau, Boris Houska

Definition at line 61 of file transfer_device.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 46 of file transfer_device.cpp.

TransferDevice::TransferDevice ( uint  _dim,
BlockName  _name = BN_DEFAULT,
double  _samplingTime = DEFAULT_SAMPLING_TIME 
)

Constructor which takes the dimension, the name and the sampling time of the transfer device.

Parameters:
[in]_dimDimension of transfer device signal.
[in]_nameName of the block.
[in]_samplingTimeSampling time.
Note:
Actuators pass the sum of their control and parameter signal dimensions.

Definition at line 54 of file transfer_device.cpp.

Copy constructor (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 75 of file transfer_device.cpp.

Destructor.

Definition at line 98 of file transfer_device.cpp.


Member Function Documentation

returnValue TransferDevice::generateNoise ( double  startTime,
double  endTime,
VariablesGrid currentNoise 
) const [protected, virtual]

Generates additive noise on the given time interval based on the internal noise settings and sampling times.

Parameters:
[in]startTimeStart time for noise generation.
[in]endTimeEnd time for noise generation.
[out]currentNoiseGenerated additive noise on given time interval.
Returns:
SUCCESSFUL_RETURN,
RET_INVALID_ARGUMENTS

Definition at line 194 of file transfer_device.cpp.

uint TransferDevice::getDim ( ) const [inline]

Returns dimension of transfer device.

Returns:
Dimension of transfer device

Returns whether dead time have been specified.

Returns:
BT_TRUE iff dead time have been specified,
BT_FALSE otherwise

Returns whether additive noise has been specified.

Returns:
BT_TRUE iff additive noise has been specified,
BT_FALSE otherwise
returnValue TransferDevice::init ( double  _startTime = 0.0,
const DVector _startValue = emptyConstVector 
) [protected, virtual]

Initializes all components of the transfer device and the lastSignal member based on the given start information.

Parameters:
[in]_startTimeStart time.
[in]_startValueInitial value of the transfer device signal.
Returns:
SUCCESSFUL_RETURN

Reimplemented in Sensor.

Definition at line 158 of file transfer_device.cpp.

Returns whether transfer device is empty (i.e. has dimension 0).

Returns:
BT_TRUE iff transfer device has dimension 0,
BT_FALSE otherwise
TransferDevice & TransferDevice::operator= ( const TransferDevice rhs)

Assignment operator (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 111 of file transfer_device.cpp.


Member Data Documentation

Array of additive noise for each component of the transfer device signal.

Definition at line 177 of file transfer_device.hpp.

Dead times for each component of the transfer device signal.

Definition at line 180 of file transfer_device.hpp.

Most recent transfer device signal.

Definition at line 175 of file transfer_device.hpp.

Noise sampling times for each component of the transfer device signal.

Definition at line 178 of file transfer_device.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:26