cl_ros_publisher::CbPublishOnce< RosMsgType > Class Template Reference

#include <cb_publish_once.hpp>

Inheritance diagram for cl_ros_publisher::CbPublishOnce< RosMsgType >:

Collaboration diagram for cl_ros_publisher::CbPublishOnce< RosMsgType >:

Public Member Functions
	CbPublishOnce ()
template<typename TMessage >
	CbPublishOnce (const TMessage &data)
template<typename TMessage >
void	setMessage (const TMessage &data)
void	onEntry () override
void	onExit () override
void	onEntry () override
void	onExit () override
Public Member Functions inherited from smacc2::ISmaccClientBehavior
	ISmaccClientBehavior ()
virtual	~ISmaccClientBehavior ()
ISmaccStateMachine *	getStateMachine ()
std::string	getName () const
template<typename SmaccClientType >
void	requiresClient (SmaccClientType *&storage)
template<typename SmaccComponentType >
void	requiresComponent (SmaccComponentType *&storage, bool throwExceptionIfNotExist=false)
virtual void	onEntry ()
virtual void	onExit ()
virtual void	executeOnEntry ()
virtual void	executeOnExit ()

Private Attributes
std::function< void()>	deferedPublishFn
ClRosPublisher *	client_

Additional Inherited Members
Protected Member Functions inherited from smacc2::ISmaccClientBehavior
virtual void	runtimeConfigure ()
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
ISmaccState *	getCurrentState ()
virtual void	dispose ()
virtual rclcpp::Node::SharedPtr	getNode () const
virtual rclcpp::Logger	getLogger () const

Detailed Description

template<typename RosMsgType>
class cl_ros_publisher::CbPublishOnce< RosMsgType >

Definition at line 28 of file cb_publish_once.hpp.

Constructor & Destructor Documentation

CbPublishOnce() [1/2]

template<typename RosMsgType >

cl_ros_publisher::CbPublishOnce< RosMsgType >::CbPublishOnce ( )

inline

Definition at line 35 of file cb_publish_once.hpp.

: deferedPublishFn(nullptr) {}

CbPublishOnce() [2/2]

template<typename RosMsgType >

template<typename TMessage >

cl_ros_publisher::CbPublishOnce< RosMsgType >::CbPublishOnce ( const TMessage &  data )

inline

Definition at line 38 of file cb_publish_once.hpp.

  {
    this->setMessage(data);
  }

References cl_ros_publisher::CbPublishOnce< RosMsgType >::setMessage().

Here is the call graph for this function:

Member Function Documentation

onEntry()

template<typename RosMsgType >

void cl_ros_publisher::CbPublishOnce< RosMsgType >::onEntry ( )

inlineoverridevirtual

Reimplemented from smacc2::SmaccClientBehavior.

Definition at line 49 of file cb_publish_once.hpp.

  {
    this->requiresClient(client_);
 
    if (deferedPublishFn != nullptr) deferedPublishFn();
  }

References cl_ros_publisher::CbPublishOnce< RosMsgType >::deferedPublishFn, and smacc2::ISmaccClientBehavior::requiresClient().

Here is the call graph for this function:

onExit()

template<typename RosMsgType >

void cl_ros_publisher::CbPublishOnce< RosMsgType >::onExit ( )

inlineoverridevirtual

Reimplemented from smacc2::SmaccClientBehavior.

Definition at line 56 of file cb_publish_once.hpp.

{}

setMessage()

template<typename RosMsgType >

template<typename TMessage >

void cl_ros_publisher::CbPublishOnce< RosMsgType >::setMessage ( const TMessage &  data )

inline

Definition at line 44 of file cb_publish_once.hpp.

  {
    deferedPublishFn = [this, data]() { this->client_->publish(data); };
  }

References cl_ros_publisher::CbPublishOnce< RosMsgType >::deferedPublishFn, and cl_ros_publisher::ClRosPublisher::publish().

Referenced by cl_ros_publisher::CbPublishOnce< RosMsgType >::CbPublishOnce().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

client_

template<typename RosMsgType >

ClRosPublisher* cl_ros_publisher::CbPublishOnce< RosMsgType >::client_

private

Definition at line 32 of file cb_publish_once.hpp.

deferedPublishFn

template<typename RosMsgType >

std::function<void()> cl_ros_publisher::CbPublishOnce< RosMsgType >::deferedPublishFn

private

Definition at line 31 of file cb_publish_once.hpp.

Referenced by cl_ros_publisher::CbPublishOnce< RosMsgType >::onEntry(), and cl_ros_publisher::CbPublishOnce< RosMsgType >::setMessage().

---

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

• smacc2_client_library/ros_publisher_client/include/ros_publisher_client/client_behaviors/cb_publish_once.hpp