Publish consumed data to a ROS image topic. More...

#include <image_publisher.h>

Inheritance diagram for fkie_message_filters::ImagePublisher:

[legend]

Public Member Functions
void	advertise (const image_transport::ImageTransport &it, const std::string &base_topic, uint32_t queue_size, bool latch=false) noexcept
	Advertise ROS image topic. More...

void	advertise (const image_transport::ImageTransport &it, const std::string &base_topic, uint32_t queue_size, const image_transport::SubscriberStatusCallback &connect_cb, const image_transport::SubscriberStatusCallback &disconnect_cb=image_transport::SubscriberStatusCallback(), const ros::VoidPtr &tracked_object=ros::VoidPtr(), bool latch=false) noexcept
	Advertise ROS image topic with subscriber status callbacks. More...

	ImagePublisher () noexcept
	Constructs an empty publisher. More...

	ImagePublisher (const image_transport::ImageTransport &it, const std::string &base_topic, uint32_t queue_size, bool latch=false) noexcept
	Constructor that advertises the given ROS image topic. More...

virtual bool	is_active () const noexcept override
	Check if the ROS publisher has at least one subscriber. More...

virtual std::string	topic () const noexcept override
	Return the configured ROS topic. More...

Public Member Functions inherited from fkie_message_filters::PublisherBase
virtual	~PublisherBase ()

Public Member Functions inherited from fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >
Connection	connect_to_source (Source< Inputs... > &src) noexcept
	Connect this sink to a source. More...

virtual void	disconnect () noexcept override
	Disconnect from all connected sources. More...

void	disconnect_from_all_sources () noexcept
	Disconnect from all connected sources. More...

virtual	~Sink ()

Public Member Functions inherited from fkie_message_filters::FilterBase
virtual void	reset () noexcept
	Reset filter state. More...

virtual	~FilterBase ()

Private Member Functions
void	receive (const sensor_msgs::ImageConstPtr &) noexcept override

Private Attributes
std::shared_ptr< image_transport::ImageTransport >	it_

image_transport::Publisher	pub_

Additional Inherited Members
Public Types inherited from fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >
using	Input = IO< Inputs... >
	Grouped input types. More...

Static Public Attributes inherited from fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >
static constexpr std::size_t	NUM_INPUTS
	Number of input arguments. More...

Protected Member Functions inherited from fkie_message_filters::PublisherBase
std::tuple< boost::signals2::connection, boost::signals2::connection >	link_with_subscriber (SubscriberBase &sub)
	Add a new subscriber that will be controlled by this publisher. More...

void	update_subscriber_state ()
	Cause all linked subscribers to subscribe or unsubscribe to their ROS topics. More...

Protected Member Functions inherited from fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >
virtual void	receive (const Inputs &... in)=0
	Process incoming data. More...

Detailed Description

Publish consumed data to a ROS image topic.

This is a specialized publisher that uses image_transport to publish to a ROS image topic. All messages which are received from the connected sources will be published on the advertised ROS topic.

Unlike regular ROS publishers, this class can be associated with one or more subscriber instances. In that case, the subscribers will subscribe to their ROS topics only if the publisher is actively used. This is a convenient method to save processing power if the filter pipeline is used only intermittently.

See also: ImageSubscriber, CameraPublisher, Publisher

Definition at line 60 of file image_publisher.h.

Constructor & Destructor Documentation

◆ ImagePublisher() [1/2]

fkie_message_filters::ImagePublisher::ImagePublisher ( )

inlinenoexcept

Constructs an empty publisher.

You need to call advertise() to actually publish to a ROS topic.

\nothrow

Definition at line 87 of file image_publisher.h.

◆ ImagePublisher() [2/2]

fkie_message_filters::ImagePublisher::ImagePublisher	(	const image_transport::ImageTransport &	it,
		const std::string &	base_topic,
		uint32_t	queue_size,
		bool	latch = `false`
	)

noexcept

Constructor that advertises the given ROS image topic.

The constructor calls advertise() for you.

\nothrow

Definition at line 44 of file image_publisher.cpp.

Member Function Documentation

◆ advertise() [1/2]

void fkie_message_filters::ImagePublisher::advertise	(	const image_transport::ImageTransport &	it,
		const std::string &	base_topic,
		uint32_t	queue_size,
		bool	latch = `false`
	)

noexcept

Advertise ROS image topic.

All arguments are passed to the ROS client library; see the ROS documentation for further information. Calling this method will automatically unadvertise any previously advertised ROS topic.

it ROS image_transport instance to handle the publishing
base_topic name of the ROS image topic, subject to remapping
queue_size size of the ROS publishing queue
latch if true, the last published message remains available for later subscribers

\nothrow

Definition at line 59 of file image_publisher.cpp.

◆ advertise() [2/2]

void fkie_message_filters::ImagePublisher::advertise	(	const image_transport::ImageTransport &	it,
		const std::string &	base_topic,
		uint32_t	queue_size,
		const image_transport::SubscriberStatusCallback &	connect_cb,
		const image_transport::SubscriberStatusCallback &	disconnect_cb = `image_transport::SubscriberStatusCallback()`,
		const ros::VoidPtr &	tracked_object = `ros::VoidPtr()`,
		bool	latch = `false`
	)

noexcept

Advertise ROS image topic with subscriber status callbacks.

All arguments are passed to the ROS client library; see the ROS documentation for further information. Calling this method will automatically unadvertise any previously advertised ROS topic.

it ROS image_transport instance to handle the publishing
base_topic name of the ROS image topic, subject to remapping
queue_size size of the ROS publishing queue
connect_cb callback that is invoked each time a new subscriber connects to the advertised topic
disconnect_cb callback that is invoked each time an existing subscriber disconnects from the advertised topic
tracked_object an associated object whose lifetime will limit the lifetime of the advertised topic
latch if true, the last published message remains available for later subscribers

\nothrow

Definition at line 78 of file image_publisher.cpp.

◆ is_active()

bool fkie_message_filters::ImagePublisher::is_active ( ) const

overridevirtualnoexcept

Check if the ROS publisher has at least one subscriber.

\nothrow

Implements fkie_message_filters::PublisherBase.

Definition at line 49 of file image_publisher.cpp.

◆ receive()

void fkie_message_filters::ImagePublisher::receive ( const sensor_msgs::ImageConstPtr & img )

overrideprivatenoexcept

Definition at line 99 of file image_publisher.cpp.

◆ topic()

std::string fkie_message_filters::ImagePublisher::topic ( ) const

overridevirtualnoexcept

Return the configured ROS topic.

\nothrow

Implements fkie_message_filters::PublisherBase.

Definition at line 54 of file image_publisher.cpp.

Member Data Documentation

◆ it_

std::shared_ptr<image_transport::ImageTransport> fkie_message_filters::ImagePublisher::it_

private

Definition at line 139 of file image_publisher.h.

◆ pub_

image_transport::Publisher fkie_message_filters::ImagePublisher::pub_

private

Definition at line 140 of file image_publisher.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImagePublisher() [1/2]

◆ ImagePublisher() [2/2]

Member Function Documentation

◆ advertise() [1/2]

◆ advertise() [2/2]

◆ is_active()

◆ receive()

◆ topic()

Member Data Documentation

◆ it_

◆ pub_