Inheritance diagram for py_parameter::ParameterContainer:

Public Member Functions
	ParameterContainer (const std::string &name, const ParameterType &type, const StateType &parameter_state_type=StateType::NONE)

	ParameterContainer (const std::string &name, const py::object &value, const ParameterType &type, const StateType &parameter_state_type=StateType::NONE)

	ParameterContainer (const ParameterContainer &parameter)

void	set_value (py::object value)

py::object	get_value () const

void	reset ()
	Reset the object to a post-construction state.

Public Member Functions inherited from state_representation::ParameterInterface
	ParameterInterface (const std::string &name, const ParameterType &type, const StateType &parameter_state_type=StateType::NONE)
	Constructor with parameter name and type.

	ParameterInterface (const ParameterInterface &parameter)
	Copy constructor.

virtual	~ParameterInterface ()=default
	Default virtual destructor.

ParameterInterface &	operator= (const ParameterInterface &state)
	Copy assignment operator that has to be defined to the custom assignment operator.

template<typename T >
std::shared_ptr< Parameter< T > >	get_parameter (bool validate_pointer=true) const
	Get a pointer to a derived Parameter instance from a ParameterInterface pointer.

template<typename T >
T	get_parameter_value () const
	Get the parameter value of a derived Parameter instance through the ParameterInterface pointer.

template<typename T >
void	set_parameter_value (const T &value)
	Set the parameter value of a derived Parameter instance through the ParameterInterface pointer.

ParameterType	get_parameter_type () const
	Get the parameter type.

StateType	get_parameter_state_type () const
	Get the state type of the parameter.

Public Member Functions inherited from state_representation::State
	State ()
	Empty constructor.

	State (const std::string &name)
	Constructor with name specification.

	State (const State &state)
	Copy constructor from another state.

virtual	~State ()=default
	Virtual destructor.

State &	operator= (const State &state)
	Copy assignment operator that has to be defined to the custom assignment operator.

const StateType &	get_type () const
	Getter of the type attribute.

const std::string &	get_name () const
	Getter of the name attribute.

bool	is_empty () const
	Getter of the empty attribute.

const std::chrono::time_point< std::chrono::steady_clock > &	get_timestamp () const
	Getter of the timestamp attribute.

virtual void	set_name (const std::string &name)
	Setter of the name attribute.

void	reset_timestamp ()
	Reset the timestamp attribute to now.

virtual void	set_data (const Eigen::VectorXd &data)
	Set the data of the state from an Eigen vector.

virtual void	set_data (const std::vector< double > &data)
	Set the data of the state from a std vector.

virtual void	set_data (const Eigen::MatrixXd &data)
	Set the data of the state from an Eigen matrix.

double	get_age () const
	Get the age of the state, i.e. the time since the last modification.

virtual bool	is_incompatible (const State &state) const
	Check if the state is incompatible for operations with the state given as argument.

bool	is_deprecated (double time_delay) const
	Check if the state is deprecated given a certain time delay.

template<typename DurationT >
bool	is_deprecated (const std::chrono::duration< int64_t, DurationT > &time_delay) const
	Check if the state is deprecated given a certain time delay.

	operator bool () const noexcept
	Boolean operator for the truthiness of a state.

Public Attributes
ParameterValues	values

Additional Inherited Members
Protected Member Functions inherited from state_representation::State
void	set_type (const StateType &type)
	Setter of the state type attribute.

void	set_empty (bool empty=true)
	Setter of the empty attribute.

void	assert_not_empty () const
	Throw an exception if the state is empty.

virtual std::string	to_string () const
	Convert the state to its string representation.

Detailed Description

Definition at line 25 of file parameter_container.hpp.

Constructor & Destructor Documentation

◆ ParameterContainer() [1/3]

py_parameter::ParameterContainer::ParameterContainer	(	const std::string &	name,
		const ParameterType &	type,
		const StateType &	parameter_state_type = `StateType::NONE`
	)

Definition at line 13 of file parameter_container.cpp.

◆ ParameterContainer() [2/3]

py_parameter::ParameterContainer::ParameterContainer	(	const std::string &	name,
		const py::object &	value,
		const ParameterType &	type,
		const StateType &	parameter_state_type = `StateType::NONE`
	)

Definition at line 40 of file parameter_container.cpp.

◆ ParameterContainer() [3/3]

py_parameter::ParameterContainer::ParameterContainer ( const ParameterContainer & parameter )

Definition at line 46 of file parameter_container.cpp.

Member Function Documentation

◆ get_value()

py::object py_parameter::ParameterContainer::get_value ( ) const

Definition at line 118 of file parameter_container.cpp.

◆ reset()

void py_parameter::ParameterContainer::reset ( )

virtual

Reset the object to a post-construction state.

Reimplemented from state_representation::State.

Definition at line 165 of file parameter_container.cpp.

◆ set_value()

void py_parameter::ParameterContainer::set_value ( py::object value )

Definition at line 53 of file parameter_container.cpp.

Member Data Documentation

◆ values

ParameterValues py_parameter::ParameterContainer::values

Definition at line 42 of file parameter_container.hpp.

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

/github/workspace/python/include/parameter_container.hpp
/github/workspace/python/source/common/parameter_container.cpp

Public Member Functions

Public Attributes

Additional Inherited Members