dynamical_systems::Ring Class Reference

Represent a Ring dynamical system limit cycle to move around a radius within a fixed width. More...

#include <Ring.hpp>

Inheritance diagram for dynamical_systems::Ring:

Public Member Functions
	Ring ()
	Empty constructor.
	Ring (const std::list< std::shared_ptr< state_representation::ParameterInterface > > &parameters)
	Constructor from an initial parameter list.
void	set_base_frame (const state_representation::CartesianState &base_frame) override
	Set a parameter.
state_representation::CartesianState	compute_dynamics (const state_representation::CartesianState &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< state_representation::CartesianState >
	IDynamicalSystem ()=default
	Empty constructor.
virtual bool	is_compatible (const state_representation::CartesianState &state) const
	Check compatibility between a state and the dynamical system.
state_representation::CartesianState	evaluate (const state_representation::CartesianState &state) const
	Evaluate the value of the dynamical system at a given state.
state_representation::CartesianState	get_base_frame () const
	Return the base frame of the dynamical system.
virtual void	set_base_frame (const state_representation::CartesianState &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

Represent a Ring dynamical system limit cycle to move around a radius within a fixed width.

Definition at line 16 of file Ring.hpp.

Constructor & Destructor Documentation

Ring() [1/2]

dynamical_systems::Ring::Ring

(

)

Empty constructor.

Definition at line 13 of file Ring.cpp.

Ring() [2/2]

dynamical_systems::Ring::Ring ( const std::list< std::shared_ptr< state_representation::ParameterInterface > > &  parameters )

explicit

Constructor from an initial parameter list.

Parameters

parameters

A parameter list containing initial parameters

Definition at line 34 of file Ring.cpp.

Member Function Documentation

compute_dynamics()

CartesianState dynamical_systems::Ring::compute_dynamics ( const state_representation::CartesianState &  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< state_representation::CartesianState >.

Definition at line 205 of file Ring.cpp.

set_base_frame()

void dynamical_systems::Ring::set_base_frame ( const state_representation::CartesianState &  base_frame )

override

Set a parameter.

Parameters

parameter

The new parameter

Definition at line 71 of file Ring.cpp.

---

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

• /github/workspace/source/dynamical_systems/include/dynamical_systems/Ring.hpp
• /github/workspace/source/dynamical_systems/src/Ring.cpp