subscriber.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_SUBSCRIBER_H
36 #define IMAGE_TRANSPORT_SUBSCRIBER_H
37 
38 #include <ros/ros.h>
39 #include <sensor_msgs/Image.h>
43 #include "exports.h"
44 
45 namespace image_transport {
46 
62 class IMAGE_TRANSPORT_DECL Subscriber
63 {
64 public:
65  Subscriber() {}
66 
73  std::string getTopic() const;
74 
78  uint32_t getNumPublishers() const;
79 
83  std::string getTransport() const;
84 
88  void shutdown();
89 
90  operator void*() const;
91  bool operator< (const Subscriber& rhs) const { return impl_ < rhs.impl_; }
92  bool operator!=(const Subscriber& rhs) const { return impl_ != rhs.impl_; }
93  bool operator==(const Subscriber& rhs) const { return impl_ == rhs.impl_; }
94 
95 private:
96  Subscriber(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
97  const boost::function<void(const sensor_msgs::ImageConstPtr&)>& callback,
98  const ros::VoidPtr& tracked_object, const TransportHints& transport_hints,
99  const SubLoaderPtr& loader);
100 
101  struct Impl;
103  typedef boost::weak_ptr<Impl> ImplWPtr;
104 
105  ImplPtr impl_;
106 
107  friend class ImageTransport;
108 };
109 
110 } //namespace image_transport
111 
112 #endif
image_transport::Subscriber::ImplWPtr
boost::weak_ptr< Impl > ImplWPtr
Definition: subscriber.h:167
transport_hints.h
image_transport::ImageTransport
Advertise and subscribe to image topics.
Definition: image_transport.h:84
boost::shared_ptr< void >
ros.h
loader_fwds.h
image_transport::Subscriber::Impl
Definition: subscriber.cpp:75
image_transport::Subscriber
Manages a subscription callback on a specific topic that can be interpreted as an Image topic.
Definition: subscriber.h:94
shutdown
ROSCONSOLE_DECL void shutdown()
operator==
bool operator==(const in6_addr a, const in6_addr b)
exports.h
image_transport
Definition: camera_common.h:41
exception.h
image_transport::TransportHints
Stores transport settings for an image topic subscription.
Definition: transport_hints.h:77
IMAGE_TRANSPORT_DECL
#define IMAGE_TRANSPORT_DECL
Definition: exports.h:15
ros::NodeHandle


image_transport
Author(s): Patrick Mihelich
autogenerated on Sun Apr 5 2020 03:15:28