An event is a predicate with memory. Its purpose is to be true only once and change value only when the underlying predicate has changed from true to false and back to true since last reading. More...

#include <Event.hpp>

Inheritance diagram for state_representation::Event:

Public Member Functions
	Event (const std::string &name)
	Constructor with name of the predicate and default false value.

bool	read_value ()
	Read the value of the event, modifying its value as it has been accessed once.

void	set_value (const bool &value) override
	Setter of the value attribute.

bool	get_previous_value () const
	Getter of the previous value. Does not affect the behavior of the event (as opposed to read_value).

Public Member Functions inherited from state_representation::Predicate
	Predicate (const std::string &name)
	Constructor with name of the predicate and default false value.

	Predicate (const std::string &name, bool value)
	Constructor with a value.

Public Member Functions inherited from state_representation::Parameter< bool >
	Parameter (const std::string &name="")
	Constructor with the name of the parameter.

	Parameter (const std::string &name, const bool &value)
	Constructor with a name and a value.

	Parameter (const Parameter< U > &parameter)
	Copy constructor.

	Parameter (const std::string &name)

	Parameter (const std::string &name, const int &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const std::vector< int > &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const double &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const std::vector< double > &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const bool &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const std::vector< bool > &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const std::string &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const std::vector< std::string > &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const CartesianState &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const CartesianPose &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const JointState &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const JointPositions &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const Ellipsoid &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const Eigen::MatrixXd &value)

	Parameter (const std::string &name)

	Parameter (const std::string &name, const Eigen::VectorXd &value)

virtual	~Parameter ()=default
	Default virtual destructor.

Parameter< bool > &	operator= (const Parameter< U > &parameter)
	Conversion equality.

U	get_value () const
	Getter of the value attribute.

const bool &	get_value () const
	Getter of the value attribute.

bool &	get_value ()
	Getter of the value attribute.

virtual void	set_value (const bool &value)
	Setter of the value attribute.

void	reset () override
	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.

Friends
std::ostream &	operator<< (std::ostream &os, const Event &event)
	Overload the ostream operator for printing.

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

An event is a predicate with memory. Its purpose is to be true only once and change value only when the underlying predicate has changed from true to false and back to true since last reading.

Definition at line 14 of file Event.hpp.

Constructor & Destructor Documentation

◆ Event()

state_representation::Event::Event ( const std::string & name )

explicit

Constructor with name of the predicate and default false value.

Definition at line 5 of file Event.cpp.

Member Function Documentation

◆ get_previous_value()

bool state_representation::Event::get_previous_value ( ) const

inline

Getter of the previous value. Does not affect the behavior of the event (as opposed to read_value).

Definition at line 64 of file Event.hpp.

◆ read_value()

bool state_representation::Event::read_value ( )

inline

Read the value of the event, modifying its value as it has been accessed once.

Definition at line 51 of file Event.hpp.

◆ set_value()

void state_representation::Event::set_value ( const bool & value )

inlineoverride

Setter of the value attribute.

Parameters

value The new value attribute

Definition at line 57 of file Event.hpp.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Event &	event
	)

friend

Overload the ostream operator for printing.

Parameters

os	The ostream to append the string representing the Event to
predicate	The Event to print

Returns: The appended ostream

Definition at line 7 of file Event.cpp.

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

/github/workspace/source/state_representation/include/state_representation/parameters/Event.hpp
/github/workspace/source/state_representation/src/parameters/Event.cpp

Public Member Functions

Friends

Additional Inherited Members