raw_publisher.h
Go to the documentation of this file.
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2009, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 #ifndef IMAGE_TRANSPORT_RAW_PUBLISHER_H
36 #define IMAGE_TRANSPORT_RAW_PUBLISHER_H
37 
39 
40 namespace image_transport {
41 
48 class RawPublisher : public SimplePublisherPlugin<sensor_msgs::Image>
49 {
50 public:
51  virtual ~RawPublisher() {}
52 
53  virtual std::string getTransportName() const
54  {
55  return "raw";
56  }
57 
58  // Override the default implementation because publishing the message pointer allows
59  // the no-copy intraprocess optimization.
60  virtual void publish(const sensor_msgs::ImageConstPtr& message) const
61  {
62  getPublisher().publish(message);
63  }
64 
65  // Override the default implementation to not copy data to a sensor_msgs::Image first
66  virtual void publish(const sensor_msgs::Image& message, const uint8_t* data) const;
67 
68 protected:
69  virtual void publish(const sensor_msgs::Image& message, const PublishFn& publish_fn) const
70  {
71  publish_fn(message);
72  }
73 
74  virtual std::string getTopicToAdvertise(const std::string& base_topic) const
75  {
76  return base_topic;
77  }
78 };
79 
80 } //namespace image_transport
81 
82 #endif
virtual std::string getTransportName() const
Get a string identifier for the transport provided by this plugin.
Definition: raw_publisher.h:53
boost::function< void(const sensor_msgs::Image &)> PublishFn
Generic function for publishing the internal message type.
virtual void publish(const sensor_msgs::Image &message, const PublishFn &publish_fn) const
Publish an image using the specified publish function. Must be implemented by the subclass...
Definition: raw_publisher.h:69
void publish(const boost::shared_ptr< M > &message) const
const ros::Publisher & getPublisher() const
Returns the internal ros::Publisher.
virtual std::string getTopicToAdvertise(const std::string &base_topic) const
Return the communication topic name for a given base topic.
Definition: raw_publisher.h:74
The default PublisherPlugin.
Definition: raw_publisher.h:48
Base class to simplify implementing most plugins to Publisher.
virtual void publish(const sensor_msgs::ImageConstPtr &message) const
Publish an image using the transport associated with this PublisherPlugin.
Definition: raw_publisher.h:60


image_transport
Author(s): Patrick Mihelich
autogenerated on Mon Feb 28 2022 22:31:45