Public Member Functions | Private Attributes
image_transport::TransportHints Class Reference

Stores transport settings for an image topic subscription. More...

#include <transport_hints.h>

List of all members.

Public Member Functions

const ros::NodeHandlegetParameterNH () const
const ros::TransportHintsgetRosHints () const
const std::string & getTransport () const
 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")

Private Attributes

ros::NodeHandle parameter_nh_
ros::TransportHints ros_hints_
std::string transport_

Detailed Description

Stores transport settings for an image topic subscription.

Definition at line 45 of file transport_hints.h.

Constructor & Destructor Documentation

image_transport::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" 
) [inline]


The default transport can be overridden by setting a certain parameter to the name of the desired transport. By default this parameter is named "image_transport" in the node's local namespace. For consistency across ROS applications, the name of this parameter should not be changed without good reason.

default_transportPreferred transport to use
ros_hintsHints to pass through to ROS subscriptions
parameter_nhNode handle to use when looking up the transport parameter. Defaults to the local namespace.
parameter_nameThe name of the transport parameter

Definition at line 62 of file transport_hints.h.

Member Function Documentation

Definition at line 81 of file transport_hints.h.

Definition at line 76 of file transport_hints.h.

const std::string& image_transport::TransportHints::getTransport ( ) const [inline]

Definition at line 71 of file transport_hints.h.

Member Data Documentation

Definition at line 89 of file transport_hints.h.

Definition at line 88 of file transport_hints.h.

Definition at line 87 of file transport_hints.h.

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

Author(s): Patrick Mihelich
autogenerated on Wed Feb 1 2017 04:05:17