Public Member Functions | Private Member Functions | Private Attributes | List of all members
gazebo::ROSPopulationPlugin Class Reference

ROS interface for the Population plugin. More...

#include <ROSPopulationPlugin.hh>

Inheritance diagram for gazebo::ROSPopulationPlugin:
Inheritance graph
[legend]

Public Member Functions

virtual void Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)
 
bool OnPopulationControl (osrf_gear::PopulationControl::Request &_req, osrf_gear::PopulationControl::Response &_res)
 Receives messages for controlling the object population plugin on the object population's topic. More...
 
virtual void Reset ()
 Documentation inherited. More...
 
 ROSPopulationPlugin ()
 Constructor. More...
 
virtual ~ROSPopulationPlugin ()
 Destructor. More...
 
- Public Member Functions inherited from gazebo::PopulationPlugin
void Pause ()
 Pause the object population. More...
 
 PopulationPlugin ()
 Constructor. More...
 
virtual void Restart ()
 Restart the the object population. More...
 
void Resume ()
 Resume the object population after a pause. More...
 
virtual ~PopulationPlugin ()
 Destructor. More...
 

Private Member Functions

virtual void Publish () const
 Overwrite this method for sending periodic updates with the plugin state. More...
 

Private Attributes

std::unique_ptr< ROSPopulationPluginPrivatedataPtr
 

Additional Inherited Members

- Protected Member Functions inherited from gazebo::PopulationPlugin
bool Enabled () const
 True when the plugin is enabled or false if it's paused. More...
 
void OnActivation (ConstGzStringPtr &_msg)
 Callback that receives activation messages. If the <activation_topic> is set in SDF, the plugin won't populate any object until the activation is received. More...
 
void OnUpdate ()
 Update the plugin. More...
 

Detailed Description

ROS interface for the Population plugin.

Definition at line 33 of file ROSPopulationPlugin.hh.

Constructor & Destructor Documentation

ROSPopulationPlugin::ROSPopulationPlugin ( )

Constructor.

Definition at line 51 of file ROSPopulationPlugin.cc.

ROSPopulationPlugin::~ROSPopulationPlugin ( )
virtual

Destructor.

Definition at line 58 of file ROSPopulationPlugin.cc.

Member Function Documentation

void ROSPopulationPlugin::Load ( physics::WorldPtr  _world,
sdf::ElementPtr  _sdf 
)
virtual

Reimplemented from gazebo::PopulationPlugin.

Definition at line 64 of file ROSPopulationPlugin.cc.

bool ROSPopulationPlugin::OnPopulationControl ( osrf_gear::PopulationControl::Request &  _req,
osrf_gear::PopulationControl::Response &  _res 
)

Receives messages for controlling the object population plugin on the object population's topic.

Parameters
[in]_reqThe message to control the object population plugin.
[out]_repIf the service succeed or not.

Definition at line 117 of file ROSPopulationPlugin.cc.

void ROSPopulationPlugin::Publish ( ) const
privatevirtual

Overwrite this method for sending periodic updates with the plugin state.

Reimplemented from gazebo::PopulationPlugin.

Definition at line 140 of file ROSPopulationPlugin.cc.

void ROSPopulationPlugin::Reset ( )
virtual

Documentation inherited.

Definition at line 112 of file ROSPopulationPlugin.cc.

Member Data Documentation

std::unique_ptr<ROSPopulationPluginPrivate> gazebo::ROSPopulationPlugin::dataPtr
private

Definition at line 60 of file ROSPopulationPlugin.hh.


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


osrf_gear
Author(s):
autogenerated on Wed Sep 7 2016 03:48:13