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::NodeHandle & getParameterNH () const
const ros::TransportHints & getRosHints () 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 11 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_transport Preferred transport to use
ros_hints Hints to pass through to ROS subscriptions
parameter_nh Node handle to use when looking up the transport parameter. Defaults to the local namespace.
parameter_name The name of the transport parameter

Definition at line 28 of file transport_hints.h.

Member Function Documentation

const ros::NodeHandle& image_transport::TransportHints::getParameterNH (  )  const [inline]

Definition at line 47 of file transport_hints.h.

const ros::TransportHints& image_transport::TransportHints::getRosHints (  )  const [inline]

Definition at line 42 of file transport_hints.h.

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

Definition at line 37 of file transport_hints.h.

Member Data Documentation

Definition at line 55 of file transport_hints.h.

ros::TransportHints image_transport::TransportHints::ros_hints_ [private]

Definition at line 54 of file transport_hints.h.

Definition at line 53 of file transport_hints.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends

Author(s): Patrick Mihelich
autogenerated on Fri Jan 11 11:44:59 2013