transport_hints.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_TRANSPORT_HINTS_H
36 #define IMAGE_TRANSPORT_TRANSPORT_HINTS_H
37 
38 #include <ros/ros.h>
39 
40 namespace image_transport {
41 
45 class TransportHints
46 {
47 public:
62  TransportHints(const std::string& default_transport = "raw",
63  const ros::TransportHints& ros_hints = ros::TransportHints(),
64  const ros::NodeHandle& parameter_nh = ros::NodeHandle("~"),
65  const std::string& parameter_name = "image_transport")
66  : ros_hints_(ros_hints), parameter_nh_(parameter_nh)
67  {
68  parameter_nh_.param(parameter_name, transport_, default_transport);
69  }
70 
71  const std::string& getTransport() const
72  {
73  return transport_;
74  }
75 
76  const ros::TransportHints& getRosHints() const
77  {
78  return ros_hints_;
79  }
80 
81  const ros::NodeHandle& getParameterNH() const
82  {
83  return parameter_nh_;
84  }
85 
86 private:
87  std::string transport_;
90 };
91 
92 } //namespace image_transport
93 
94 #endif
image_transport::TransportHints::getTransport
const std::string & getTransport() const
Definition: transport_hints.h:135
ros.h
ros::TransportHints
image_transport::TransportHints::getParameterNH
const ros::NodeHandle & getParameterNH() const
Definition: transport_hints.h:145
image_transport::TransportHints::parameter_nh_
ros::NodeHandle parameter_nh_
Definition: transport_hints.h:153
image_transport::TransportHints::transport_
std::string transport_
Definition: transport_hints.h:151
image_transport::TransportHints::ros_hints_
ros::TransportHints ros_hints_
Definition: transport_hints.h:152
image_transport::TransportHints::getRosHints
const ros::TransportHints & getRosHints() const
Definition: transport_hints.h:140
image_transport
Definition: camera_common.h:41
ros::NodeHandle::param
T param(const std::string &param_name, const T &default_val) const
image_transport::TransportHints::TransportHints
TransportHints(const std::string &default_transport="raw", const ros::TransportHints &ros_hints=ros::TransportHints(), const ros::NodeHandle &parameter_nh=ros::NodeHandle("~"), const std::string &parameter_name="image_transport")
Constructor.
Definition: transport_hints.h:126
ros::NodeHandle


image_transport
Author(s): Patrick Mihelich
autogenerated on Sat Jan 20 2024 03:14:50