Dummy runner. More...

Inheritance diagram for capabilities2_runner::DummyRunner:

Collaboration diagram for capabilities2_runner::DummyRunner:

Public Member Functions
void	start (rclcpp::Node::SharedPtr node, const runner_opts &run_config, const std::string &bond_id) override
	start the runner

void	stop (const std::string &bond_id, const std::string &instance_id="") override
	stop the runner

void	trigger (capabilities2_events::EventParameters &parameters, const std::string &bond_id, const std::string &instance_id="") override
	Trigger the runner.

Public Member Functions inherited from capabilities2_runner::RunnerBase
	RunnerBase ()

	~RunnerBase ()=default

void	init_base (rclcpp::Node::SharedPtr node, const runner_opts &run_config)
	Initializer function for initializing the base runner in place of constructor due to plugin semantics.

void	enable_events (std::shared_ptr< capabilities2_events::EventBase > events)
	enable events system for this runner

void	add_connection (const std::string &connection_id, const capabilities2_msgs::msg::CapabilityEventCode &type, const capabilities2_msgs::msg::Capability &target, std::function< void(const std::string &, const std::string &, const std::string &, capabilities2_events::EventParameters)> callback)
	make EventNode::add_connection public method on runner api.

const std::string	get_package_name ()
	get the package name to which the runner belong to.

const std::string &	get_interface () const
	get the interface of the runner.

const std::string &	get_provider () const
	get the provider of the runner.

const std::string &	get_started_by () const
	get the starter of the runner.

const std::string &	get_pid () const
	get the pid of the runner.

Public Member Functions inherited from capabilities2_events::EventNode
	EventNode (std::shared_ptr< EventBase > event_emitter=nullptr)

virtual	~EventNode ()=default

void	emit_event (const std::string &bond_id, const std::string &instance_id, const uint8_t &event_type, capabilities2_events::EventParameters parameters=capabilities2_events::EventParameters())
	emit an event from this event node to all matching connections

Additional Inherited Members
Protected Member Functions inherited from capabilities2_runner::RunnerBase
virtual capabilities2_events::EventParameters	param_on_started ()
	Update on_started event parameters with new data if available.

virtual capabilities2_events::EventParameters	param_on_stopped ()
	Update on_stopped event parameters with new data if available.

virtual capabilities2_events::EventParameters	param_on_failure ()
	Update on_failure event parameters with new data if available.

virtual capabilities2_events::EventParameters	param_on_success ()
	Update on_success event parameters with new data if available.

const std::string	get_resource_name_by_type (const std::string &resource_type, const std::string &msg_type) const
	Get a resource name by data type from the config.

const std::string	get_parameter_name_by_type (const std::string &param_type) const
	Get a parameter name by type.

const std::string	get_topic_name_by_type (const std::string &topic_type) const
	Get a topic name by type.

const std::string	get_service_name_by_type (const std::string &srv_type) const
	Get a service name by type.

const std::string	get_action_name_by_type (const std::string &action_type) const
	Get the action name by type object.

const std::string	get_first_resource_name (const std::string &resource_type) const
	get first name of a given resource

const std::string	get_first_parameter_name () const
	Get the first parameter name.

const std::string	get_first_topic_name () const
	Get the first topic name.

const std::string	get_first_service_name () const
	Get the first service name.

const std::string	get_first_action_name () const
	Get the first action name.

void	emit_started (const std::string &bond_id, const std::string &instance_id, capabilities2_events::EventParameters parameters=capabilities2_events::EventParameters())
	emit STARTED event

void	emit_stopped (const std::string &bond_id, const std::string &instance_id, capabilities2_events::EventParameters parameters=capabilities2_events::EventParameters())
	emit STOPPED event

void	emit_succeeded (const std::string &bond_id, const std::string &instance_id, capabilities2_events::EventParameters parameters=capabilities2_events::EventParameters())
	emit SUCCEEDED event

void	emit_failed (const std::string &bond_id, const std::string &instance_id, capabilities2_events::EventParameters parameters=capabilities2_events::EventParameters())
	emit FAILED event

Protected Member Functions inherited from capabilities2_events::EventNode
void	set_source (const capabilities2_msgs::msg::Capability &src)
	Set the source object.

void	set_event_emitter (std::shared_ptr< EventBase > event_emitter)
	event emitter for this event node

void	add_connection (const std::string &connection_id, const capabilities2_msgs::msg::CapabilityEventCode &type, const capabilities2_msgs::msg::Capability &target, EventBase::event_callback_t event_cb)
	make EventNode::add_connection public method on runner api.

void	remove_connection (const std::string &connection_id)
	Remove a connection by its id.

void	clear_connections ()
	clear all connections from this event node

std::vector< capabilities2_msgs::msg::CapabilityConnection >	list_connections () const
	List all connections from this event node.

bool	has_connection (const std::string &connection_id) const
	Check if a connection exists.

size_t	connection_count () const
	current connection count

const std::string &	get_id () const
	unique id of this event node

const capabilities2_msgs::msg::Capability &	get_source () const
	source capability of this event node

bool	is_event_emitter_set () const
	event emitter is set on this node

Protected Attributes inherited from capabilities2_runner::RunnerBase
rclcpp::Node::SharedPtr	node_
	shared pointer to the capabilities node Allows to use ros node related functionalities

runner_opts	run_config_
	run_config_ runner configuration

Detailed Description

Dummy runner.

A sample runner that can be used to test the functionality of capabilities server. It does not perform any real action but logs messages when started and stopped.

Member Function Documentation

◆ start()

void capabilities2_runner::DummyRunner::start	(	rclcpp::Node::SharedPtr	node,
		const runner_opts &	run_config,
		const std::string &	bond_id
	)

inlineoverridevirtual

start the runner

runner plugin api

Parameters

node	shared pointer to the capabilities node. Allows to use ros node related functionalities
run_config	runner configuration loaded from the yaml file

Attention: Must call init_base in derived class implementation and should call start event

Implements capabilities2_runner::RunnerBase.

◆ stop()

void capabilities2_runner::DummyRunner::stop	(	const std::string &	bond_id,
		const std::string &	instance_id = `""`
	)

inlineoverridevirtual

stop the runner

Attention: should clean up threads and should call stop event

Implements capabilities2_runner::RunnerBase.

◆ trigger()

void capabilities2_runner::DummyRunner::trigger	(	capabilities2_events::EventParameters &	parameters,
		const std::string &	bond_id,
		const std::string &	instance_id = `""`
	)

inlineoverridevirtual

Trigger the runner.

FIXME: implement new event subsystem

This method allows insertion of parameters in a runner after it has been initialized. it is an approach to parameterise capabilities. Internally starts up RunnerBase::triggerExecution in a thread

Parameters

parameters	capability options that contain parameters for the trigger
bond_id	unique identifier for the group of connections associated with this runner trigger event
instance_id	unique identifier for the instance of the capability

Attention: should call success and failure events with parameters and bond_id when the trigger process completes.

Implements capabilities2_runner::RunnerBase.

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

capabilities2_runner/src/dummy_runner.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ start()

◆ stop()

◆ trigger()