subscriber_plugin.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 * 
00004 *  Copyright (c) 2009, Willow Garage, Inc.
00005 *  All rights reserved.
00006 * 
00007 *  Redistribution and use in source and binary forms, with or without
00008 *  modification, are permitted provided that the following conditions
00009 *  are met:
00010 * 
00011 *   * Redistributions of source code must retain the above copyright
00012 *     notice, this list of conditions and the following disclaimer.
00013 *   * Redistributions in binary form must reproduce the above
00014 *     copyright notice, this list of conditions and the following
00015 *     disclaimer in the documentation and/or other materials provided
00016 *     with the distribution.
00017 *   * Neither the name of the Willow Garage nor the names of its
00018 *     contributors may be used to endorse or promote products derived
00019 *     from this software without specific prior written permission.
00020 * 
00021 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032 *  POSSIBILITY OF SUCH DAMAGE.
00033 *********************************************************************/
00034 
00035 #ifndef IMAGE_TRANSPORT_SUBSCRIBER_PLUGIN_H
00036 #define IMAGE_TRANSPORT_SUBSCRIBER_PLUGIN_H
00037 
00038 #include <ros/ros.h>
00039 #include <sensor_msgs/Image.h>
00040 #include <boost/noncopyable.hpp>
00041 #include "image_transport/transport_hints.h"
00042 
00043 namespace image_transport {
00044 
00048 class SubscriberPlugin : boost::noncopyable
00049 {
00050 public:
00051   typedef boost::function<void(const sensor_msgs::ImageConstPtr&)> Callback;
00052   
00053   virtual ~SubscriberPlugin() {}
00054 
00059   virtual std::string getTransportName() const = 0;
00060 
00064   void subscribe(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
00065                  const Callback& callback, const ros::VoidPtr& tracked_object = ros::VoidPtr(),
00066                  const TransportHints& transport_hints = TransportHints())
00067   {
00068     return subscribeImpl(nh, base_topic, queue_size, callback, tracked_object, transport_hints);
00069   }
00070 
00074   void subscribe(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
00075                  void(*fp)(const sensor_msgs::ImageConstPtr&),
00076                  const TransportHints& transport_hints = TransportHints())
00077   {
00078     return subscribe(nh, base_topic, queue_size,
00079                      boost::function<void(const sensor_msgs::ImageConstPtr&)>(fp),
00080                      ros::VoidPtr(), transport_hints);
00081   }
00082 
00086   template<class T>
00087   void subscribe(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
00088                  void(T::*fp)(const sensor_msgs::ImageConstPtr&), T* obj,
00089                  const TransportHints& transport_hints = TransportHints())
00090   {
00091     return subscribe(nh, base_topic, queue_size, boost::bind(fp, obj, _1), ros::VoidPtr(), transport_hints);
00092   }
00093 
00097   template<class T>
00098   void subscribe(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
00099                  void(T::*fp)(const sensor_msgs::ImageConstPtr&),
00100                  const boost::shared_ptr<T>& obj,
00101                  const TransportHints& transport_hints = TransportHints())
00102   {
00103     return subscribe(nh, base_topic, queue_size, boost::bind(fp, obj.get(), _1), obj, transport_hints);
00104   }
00105 
00109   virtual std::string getTopic() const = 0;
00110 
00114   virtual uint32_t getNumPublishers() const = 0;
00115 
00119   virtual void shutdown() = 0;
00120 
00125   static std::string getLookupName(const std::string& transport_type)
00126   {
00127     return "image_transport/" + transport_type + "_sub";
00128   }
00129 
00130 protected:
00134   virtual void subscribeImpl(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
00135                              const Callback& callback, const ros::VoidPtr& tracked_object,
00136                              const TransportHints& transport_hints) = 0;
00137 };
00138 
00139 } //namespace image_transport
00140 
00141 #endif


image_transport
Author(s): Patrick Mihelich
autogenerated on Mon Oct 6 2014 00:42:37