mauve::ros::SubscriberCore< ROS_T, T > Struct Template Reference

Core of the ROS Subscriber. More...

#include <Subscriber.hpp>

Inheritance diagram for mauve::ros::SubscriberCore< ROS_T, T >:

Collaboration diagram for mauve::ros::SubscriberCore< ROS_T, T >:

Public Member Functions
void	cleanup_hook () finaloverride
	Hook function called when cleaning the shell. More...
bool	configure_hook () finaloverride
	Hook function called when configuring the shell. More...
runtime::StatusValue< T >	read ()
	Read the value received on the topic with its status. More...
runtime::DataStatus	read_status ()
	Read the status of the value received on the topic. More...
T	read_value ()
	Read the value received on the topic. More...
void	update ()
	Update function: write received message to output. More...
Public Member Functions inherited from mauve::runtime::Core< RosShell< ROS_T, T > >
	Core (Core const &core)=delete
	Constructor by copy. More...
void	cleanup () overridefinal
	Cleanup the object.
bool	configure () overridefinal
	Configure the object.
std::string	container_name () const override
	Get the core container name.
bool	is_configured () const overridefinal
	Get the configuration status of the configurable object. More...
AbstractLogger &	logger () const override
	Get the logger.
Core &	operator= (Core const &core)=delete
	Copy operator. More...
std::string	shell_type_name () const override
	Get the shell type name. More...
Public Member Functions inherited from mauve::runtime::AbstractCore
	AbstractCore ()
	Default constructor. More...
virtual	~AbstractCore () noexcept
	Default descructor. More...
virtual std::string	to_string () const
std::string	type_name () const
	Get type name. More...
Public Member Functions inherited from mauve::runtime::HasProperty
const std::vector< AbstractProperty * >	get_properties () const
	Get the properties of the shell. More...
std::size_t	get_properties_size () const
AbstractProperty *	get_property (std::string const &name) const
AbstractProperty *	get_property (int index) const

Additional Inherited Members
Protected Member Functions inherited from mauve::runtime::Core< RosShell< ROS_T, T > >
	Core ()
	Default constructor. More...
virtual	~Core () noexcept
	Default descructor. More...
RosShell< ROS_T, T > &	shell () const
	Access to the instantiated shell. More...
Protected Member Functions inherited from mauve::runtime::HasProperty
template<typename T >
Property< T > &	mk_property (std::string const &name, T init_value)
	Create a new property. More...

Detailed Description

template<typename ROS_T, typename T>
struct mauve::ros::SubscriberCore< ROS_T, T >

Core of the ROS Subscriber.

Template Parameters

T	MAUVE Type
ROS_T	ROS Type

Member Function Documentation

template<typename ROS_T , typename T >

void mauve::ros::SubscriberCore< ROS_T, T >::cleanup_hook ( )

finaloverridevirtual

Hook function called when cleaning the shell.

Redefine this function in Shell subclasses to specify the behavior of your shell when being cleaned up.

Reimplemented from mauve::runtime::WithHook.

template<typename ROS_T , typename T >

bool mauve::ros::SubscriberCore< ROS_T, T >::configure_hook ( )

finaloverridevirtual

Hook function called when configuring the shell.

Redefine this function in Shell subclasses to specify the behavior of your shell when being configured.

Returns

true if configure succeeds

Reimplemented from mauve::runtime::WithHook.

template<typename ROS_T , typename T >

runtime::StatusValue<T> mauve::ros::SubscriberCore< ROS_T, T >::read ( )

inline

Read the value received on the topic with its status.

Returns

the received value converted to type T with s tatus

template<typename ROS_T , typename T >

runtime::DataStatus mauve::ros::SubscriberCore< ROS_T, T >::read_status ( )

inline

Read the status of the value received on the topic.

Returns

the status of the received value

template<typename ROS_T , typename T >

T mauve::ros::SubscriberCore< ROS_T, T >::read_value ( )

inline

Read the value received on the topic.

Returns

the received value converted to type T

template<typename ROS_T , typename T >

void mauve::ros::SubscriberCore< ROS_T, T >::update

(

)

Update function: write received message to output.