corbo::DisturbanceInterface Class Reference

#include <disturbance_interface.h>

Inheritance diagram for corbo::DisturbanceInterface:

Public Types
using	Ptr = std::shared_ptr< DisturbanceInterface >

Public Member Functions
virtual bool	checkParameters (int values_dim, std::stringstream *issues) const
	Check the underlying parameter configuration for validity. More...
virtual void	disturb (const Time &t, const Eigen::Ref< const Eigen::VectorXd > &values, Eigen::Ref< Eigen::VectorXd > disturbed_values)=0
	Modify values according to the underlying disturbance model. More...
virtual Ptr	getInstance () const =0
	Return a newly created shared instance of the implemented class. More...
virtual void	reset ()=0
	reset internal state More...
virtual	~DisturbanceInterface ()
	Virtual destructor. More...

Static Public Member Functions
static Factory< DisturbanceInterface > &	getFactory ()
	Get access to the associated factory. More...

Detailed Description

Definition at line 40 of file disturbance_interface.h.

Member Typedef Documentation

Ptr

using corbo::DisturbanceInterface::Ptr = std::shared_ptr<DisturbanceInterface>

Definition at line 43 of file disturbance_interface.h.

Constructor & Destructor Documentation

~DisturbanceInterface()

virtual corbo::DisturbanceInterface::~DisturbanceInterface ( )

inlinevirtual

Virtual destructor.

Definition at line 46 of file disturbance_interface.h.

Member Function Documentation

checkParameters()

virtual bool corbo::DisturbanceInterface::checkParameters ( int  values_dim, std::stringstream *  issues  ) const

inlinevirtual

Check the underlying parameter configuration for validity.

This method might be useful if the class has been configured via a message from another class and the internal dimensions must fulfil some requirements.

Parameters

[in]	values_dim	Expected dimension of the value vector to be disturbed
[out]	issues	Issue related messages are forwarded to this stream (optional)

Reimplemented in corbo::DisturbanceGaussianNoise.

Definition at line 71 of file disturbance_interface.h.

disturb()

virtual void corbo::DisturbanceInterface::disturb ( const Time &  t, const Eigen::Ref< const Eigen::VectorXd > &  values, Eigen::Ref< Eigen::VectorXd >  disturbed_values  )

pure virtual

Modify values according to the underlying disturbance model.

Remarks

This method allows alias between input and output parameters

Parameters

[in]	t	Current time stamp
[in]	values	Value vector to be disturbed
[out]	disturbed_values	Disturbed value vector (alias-safe) [must be preallocated]

Implemented in corbo::DisturbanceGaussianNoise.

getFactory()

static Factory<DisturbanceInterface>& corbo::DisturbanceInterface::getFactory ( )

inlinestatic

Get access to the associated factory.

Definition at line 77 of file disturbance_interface.h.

getInstance()

virtual Ptr corbo::DisturbanceInterface::getInstance ( ) const

pure virtual

Return a newly created shared instance of the implemented class.

Implemented in corbo::DisturbanceGaussianNoise.

reset()

virtual void corbo::DisturbanceInterface::reset ( )

pure virtual

reset internal state

Implemented in corbo::DisturbanceGaussianNoise.

---

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

• disturbance_interface.h