A predicate is a boolean parameter as in the logic formalism. More...

#include <Predicate.hpp>

Inheritance diagram for state_representation::Predicate:

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

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

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

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

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

	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. More...

U	get_value () const
	Getter of the value attribute. More...

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

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

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

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. More...

	ParameterInterface (const ParameterInterface &parameter)
	Copy constructor. More...

virtual	~ParameterInterface ()=default
	Default virtual destructor.

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

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. More...

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

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

ParameterType	get_parameter_type () const
	Get the parameter type. More...

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

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

	State (const StateType &type)
	Constructor only specifying the type of the state from the StateType enumeration. More...

	State (const StateType &type, const std::string &name, const bool &empty=true)
	Constructor with name specification. More...

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

virtual	~State ()=default
	Virtual destructor.

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

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

bool	is_empty () const
	Getter of the empty attribute. More...

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

void	set_filled ()
	Setter of the empty attribute to false and also reset the timestamp. More...

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

void	set_timestamp (const std::chrono::time_point< std::chrono::steady_clock > &timepoint)
	Setter of the timestamp attribute. More...

void	reset_timestamp ()
	Reset the timestamp attribute to now. More...

const std::string &	get_name () const
	Getter of the name as const reference. More...

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

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

virtual bool	is_compatible (const State &state) const
	Check if the state is compatible for operations with the state given as argument. More...

virtual void	initialize ()
	Initialize the State to a zero value. More...

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

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

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

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

Friends
std::ostream &	operator<< (std::ostream &os, const Predicate &predicate)
	Overload the ostream operator for printing. More...

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

Detailed Description

A predicate is a boolean parameter as in the logic formalism.

Definition at line 11 of file Predicate.hpp.

Constructor & Destructor Documentation

◆ Predicate() [1/2]

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

explicit

Constructor with name of the predicate and default false value.

Definition at line 5 of file Predicate.cpp.

◆ Predicate() [2/2]

state_representation::Predicate::Predicate	(	const std::string &	name,
		bool	value
	)

explicit

Constructor with a value.

Parameters

name	The name of the predicate
value	Initial value of the predicate

Definition at line 7 of file Predicate.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Predicate &	predicate
	)

friend

Overload the ostream operator for printing.

Parameters

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

Returns: the appended ostream

Definition at line 9 of file Predicate.cpp.

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

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

Public Member Functions