capabilities2_events::PublishedEvent Class Reference

#include "published_event.hpp"

Inheritance diagram for capabilities2_events::PublishedEvent:

Collaboration diagram for capabilities2_events::PublishedEvent:

Public Member Functions
	PublishedEvent (rclcpp::Publisher< capabilities2_msgs::msg::CapabilityEventStamped >::SharedPtr event_pub)
	~PublishedEvent ()=default
void	emit (const std::string &connection_id, const uint8_t &event_code, const capabilities2_msgs::msg::Capability &source, const capabilities2_msgs::msg::Capability &target, EventBase::event_callback_t callback) override
	see EventBase::emit, specialised to publish events
void	on_server_ready (const std::string &msg)
	on server ready event
void	on_process_launched (const std::string &pid)
	on process launched event
void	on_process_terminated (const std::string &pid)
	on process terminated event
void	on_triggered (const std::string &trigger_id)
	on triggered event from server
void	on_connected (const std::string &source, const std::string &target)
	on connected event from server
void	on_disconnected (const std::string &source, const std::string &target)
	on disconnected event from server
Public Member Functions inherited from capabilities2_events::EventBase
	EventBase ()
	~EventBase ()=default

Private Attributes
rclcpp::Publisher< capabilities2_msgs::msg::CapabilityEventStamped >::SharedPtr	event_pub_

Additional Inherited Members
Public Types inherited from capabilities2_events::EventBase
typedef std::string	capability_str_t
typedef capabilities2_events::EventParameters	parameter_t
typedef std::string	access_id_t
typedef std::string	target_instance_id_t
typedef std::function< void(const access_id_t &, const capability_str_t &, const target_instance_id_t &, parameter_t)>	event_callback_t

Constructor & Destructor Documentation

PublishedEvent()

capabilities2_events::PublishedEvent::PublishedEvent ( rclcpp::Publisher< capabilities2_msgs::msg::CapabilityEventStamped >::SharedPtr  event_pub )

inline

~PublishedEvent()

capabilities2_events::PublishedEvent::~PublishedEvent ( )

default

Member Function Documentation

emit()

void capabilities2_events::PublishedEvent::emit ( const std::string &  connection_id, const uint8_t &  event_code, const capabilities2_msgs::msg::Capability &  source, const capabilities2_msgs::msg::Capability &  target, EventBase::event_callback_t  callback  )

inlineoverridevirtual

see EventBase::emit, specialised to publish events

Reimplemented from capabilities2_events::EventBase.

on_connected()

void capabilities2_events::PublishedEvent::on_connected ( const std::string &  source, const std::string &  target  )

inlinevirtual

on connected event from server

Parameters

source
target

Implements capabilities2_events::EventBase.

on_disconnected()

void capabilities2_events::PublishedEvent::on_disconnected ( const std::string &  source, const std::string &  target  )

inlinevirtual

on disconnected event from server

Parameters

source
target

Implements capabilities2_events::EventBase.

on_process_launched()

void capabilities2_events::PublishedEvent::on_process_launched ( const std::string &  pid )

inlinevirtual

on process launched event

Parameters

pid

Implements capabilities2_events::EventBase.

on_process_terminated()

void capabilities2_events::PublishedEvent::on_process_terminated ( const std::string &  pid )

inlinevirtual

on process terminated event

Parameters

pid

Implements capabilities2_events::EventBase.

on_server_ready()

void capabilities2_events::PublishedEvent::on_server_ready ( const std::string &  msg )

inlinevirtual

on server ready event

Parameters

msg

Implements capabilities2_events::EventBase.

on_triggered()

void capabilities2_events::PublishedEvent::on_triggered ( const std::string &  trigger_id )

inlinevirtual

on triggered event from server

Parameters

trigger_id

Implements capabilities2_events::EventBase.

Member Data Documentation

event_pub_

rclcpp::Publisher<capabilities2_msgs::msg::CapabilityEventStamped>::SharedPtr capabilities2_events::PublishedEvent::event_pub_

private

---

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

• capabilities2_events/include/capabilities2_events/published_event.hpp