#include <parameter_events_filter.hpp>

Public Types
enum	EventType { EventType::NEW, EventType::DELETED, EventType::CHANGED }

using	EventPair = std::pair< EventType, const rcl_interfaces::msg::Parameter * >
	Used for the listed results. More...

Public Member Functions
	ParameterEventsFilter (std::shared_ptr< const rcl_interfaces::msg::ParameterEvent > event, const std::vector< std::string > &names, const std::vector< EventType > &types)
	Construct a filtered view of a parameter event. More...

const std::vector< EventPair > &	get_events () const
	Get the result of the filter. More...

Member Typedef Documentation

◆ EventPair

using rclcpp::ParameterEventsFilter::EventPair = std::pair<EventType, const rcl_interfaces::msg::Parameter *>

Used for the listed results.

Member Enumeration Documentation

◆ EventType

enum rclcpp::ParameterEventsFilter::EventType

strong

Enumerator
NEW
DELETED
CHANGED

Constructor & Destructor Documentation

◆ ParameterEventsFilter()

rclcpp::ParameterEventsFilter::ParameterEventsFilter	(	std::shared_ptr< const rcl_interfaces::msg::ParameterEvent >	event,
		const std::vector< std::string > &	names,
		const std::vector< EventType > &	types
	)

Construct a filtered view of a parameter event.

Parameters

[in]	event	The parameter event message to filter.
[in]	names	A list of parameter names of interest.
[in]	types	A list of the types of parameter events of iterest. EventType NEW, DELETED, or CHANGED

Example Usage:

If you have recieved a parameter event and are only interested in parameters foo and bar being added or changed but don't care about deletion.

auto res = rclcpp::ParameterEventsFilter(
  event_shared_ptr,
  {"foo", "bar"},
  {rclcpp::ParameterEventsFilter::EventType::NEW, rclcpp::ParameterEventsFilter::EventType::CHANGED});

Member Function Documentation

◆ get_events()

const std::vector<EventPair>& rclcpp::ParameterEventsFilter::get_events ( ) const

Get the result of the filter.

Returns: A std::vector<EventPair> of all matching parameter changes in this event.

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

include/rclcpp/parameter_events_filter.hpp

Public Types

Public Member Functions