All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::transport::SubscribeOptions Class Reference

Options for a subscription. More...

#include <transport/transport.hh>

Public Member Functions

 SubscribeOptions ()
 Constructor. More...
 
bool GetLatching () const
 Are we latching? More...
 
std::string GetMsgType () const
 Get the type of the topic we're subscribed to. More...
 
NodePtr GetNode () const
 Get the node we're subscribed to. More...
 
std::string GetTopic () const
 Get the topic we're subscribed to. More...
 
template<class M >
void Init (const std::string &_topic, NodePtr _node, bool _latching)
 Initialize the options. More...
 
void Init (const std::string &_topic, NodePtr _node, bool _latching)
 Initialize the options. More...
 

Detailed Description

Options for a subscription.

Constructor & Destructor Documentation

gazebo::transport::SubscribeOptions::SubscribeOptions ( )
inline

Constructor.

Member Function Documentation

bool gazebo::transport::SubscribeOptions::GetLatching ( ) const
inline

Are we latching?

Returns
true if we're latching the latest message, false otherwise
std::string gazebo::transport::SubscribeOptions::GetMsgType ( ) const
inline

Get the type of the topic we're subscribed to.

Returns
The type of the topic we're subscribed to
NodePtr gazebo::transport::SubscribeOptions::GetNode ( ) const
inline

Get the node we're subscribed to.

Returns
The associated node
std::string gazebo::transport::SubscribeOptions::GetTopic ( ) const
inline

Get the topic we're subscribed to.

Returns
The topic we're subscribed to
template<class M >
void gazebo::transport::SubscribeOptions::Init ( const std::string &  _topic,
NodePtr  _node,
bool  _latching 
)
inline

Initialize the options.

Parameters
[in]_topicTopic we're subscribing to
[in,out]_nodeThe associated node
[in]_latchingIf true, latch the latest message; if false, don't latch

References gzthrow, and NULL.

Referenced by gazebo::transport::Node::Subscribe().

void gazebo::transport::SubscribeOptions::Init ( const std::string &  _topic,
NodePtr  _node,
bool  _latching 
)
inline

Initialize the options.

This version of init is only used when creating subscribers of raw data.

Parameters
[in]_topicTopic we're subscribing to
[in,out]_nodeThe associated node
[in]_latchingIf true, latch the latest message; if false, don't latch

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