A default dynamical system that just returns an empty state. More...

#include <DefaultDynamicalSystem.hpp>

Inheritance diagram for dynamical_systems::DefaultDynamicalSystem< S >:

Public Member Functions
S	compute_dynamics (const S &state) const override
	Compute the dynamics of the input state. Internal function, to be redefined based on the type of dynamical system, called by the evaluate function.

Public Member Functions inherited from dynamical_systems::IDynamicalSystem< S >
	IDynamicalSystem ()=default
	Empty constructor.

virtual bool	is_compatible (const S &state) const
	Check compatibility between a state and the dynamical system.

S	evaluate (const S &state) const
	Evaluate the value of the dynamical system at a given state.

S	get_base_frame () const
	Return the base frame of the dynamical system.

virtual void	set_base_frame (const S &base_frame)
	Set the base frame of the dynamical system.

Public Member Functions inherited from state_representation::ParameterMap
	ParameterMap ()=default
	Empty constructor.

	ParameterMap (const ParameterInterfaceList &parameters)
	Construct the parameter map with an initial list of parameters.

	ParameterMap (const ParameterInterfaceMap &parameters)
	Construct the parameter map with an initial map of parameters.

std::shared_ptr< ParameterInterface >	get_parameter (const std::string &name) const
	Get a parameter by its name.

ParameterInterfaceMap	get_parameters () const
	Get a map of all the <name, parameter> pairs.

template<typename T >
T	get_parameter_value (const std::string &name) const
	Get a parameter value by its name.

ParameterInterfaceList	get_parameter_list () const
	Get a list of all the parameters.

void	set_parameter (const std::shared_ptr< ParameterInterface > &parameter)
	Set a parameter.

void	set_parameters (const ParameterInterfaceList &parameters)
	Set parameters from a list of parameters.

void	set_parameters (const ParameterInterfaceMap &parameters)
	Set parameters from a map with <name, parameter> pairs.

template<typename T >
void	set_parameter_value (const std::string &name, const T &value)
	Set a parameter value by its name.

void	remove_parameter (const std::string &name)
	Remove a parameter from the parameter map.

Additional Inherited Members
Protected Member Functions inherited from state_representation::ParameterMap
void	assert_parameter_valid (const std::shared_ptr< ParameterInterface > &parameter)
	Check if a parameter exists and has the expected type, throw an exception otherwise.

Protected Attributes inherited from state_representation::ParameterMap
ParameterInterfaceMap	parameters_
	map of parameters by name

Detailed Description

template<class S>
class dynamical_systems::DefaultDynamicalSystem< S >

A default dynamical system that just returns an empty state.

Template Parameters

S	Underlying state type of the dynamical system

Definition at line 14 of file DefaultDynamicalSystem.hpp.

Member Function Documentation

◆ compute_dynamics()

template<class S >

S dynamical_systems::DefaultDynamicalSystem< S >::compute_dynamics ( const S & state ) const

overridevirtual

Compute the dynamics of the input state. Internal function, to be redefined based on the type of dynamical system, called by the evaluate function.

Parameters

state The input state

Returns: The output state

Implements dynamical_systems::IDynamicalSystem< S >.

Definition at line 35 of file DefaultDynamicalSystem.hpp.

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

/github/workspace/source/dynamical_systems/include/dynamical_systems/DefaultDynamicalSystem.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compute_dynamics()