Public Member Functions | List of all members
gazebo::SimStateEventSource Class Reference

SimEvent that fires when the simulation is paused/resumed. More...

#include <SimStateEventSource.hh>

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

Public Member Functions

 SimStateEventSource (transport::PublisherPtr _pub, physics::WorldPtr _world)
 Constructor. More...
 
virtual ~SimStateEventSource ()
 Dtor. More...
 
virtual void Load (const sdf::ElementPtr _sdf)
 Load the name of the event from the world file. More...
 
void OnPause (bool _p)
 Callback for the pause event. More...
 
virtual void OnUpdate (const common::UpdateInfo &_info)
 Update for every time step. More...
 
- Public Member Functions inherited from gazebo::EventSource
 EventSource (transport::PublisherPtr _pub, const std::string &_type, physics::WorldPtr _world)
 Constructor. More...
 
virtual ~EventSource ()
 Destructor. More...
 
void Emit (const std::string &_data) const
 emit an event with data to the internal publisher (and using the internal type) More...
 
virtual void Init ()
 Initialize the event. More...
 
virtual bool IsActive () const
 An event source can be used to enable other events. More...
 

Additional Inherited Members

- Protected Attributes inherited from gazebo::EventSource
bool active
 True if the event source is active. More...
 
std::string name
 Name of the event. More...
 
transport::PublisherPtr pub
 a way to send messages to the other topics (to the REST) More...
 
std::string type
 Type of event. More...
 
physics::WorldPtr world
 Pointer to the world. More...
 

Detailed Description

SimEvent that fires when the simulation is paused/resumed.

Constructor & Destructor Documentation

gazebo::SimStateEventSource::SimStateEventSource ( transport::PublisherPtr  _pub,
physics::WorldPtr  _world 
)

Constructor.

Parameters
[in]_pubpublisher for the SimEvents
[in]_worldpointer to the world.
virtual gazebo::SimStateEventSource::~SimStateEventSource ( )
virtual

Dtor.

Member Function Documentation

virtual void gazebo::SimStateEventSource::Load ( const sdf::ElementPtr  _sdf)
virtual

Load the name of the event from the world file.

Parameters
[in]_sdfthe event element in the world file

Reimplemented from gazebo::EventSource.

void gazebo::SimStateEventSource::OnPause ( bool  _p)

Callback for the pause event.

Parameters
[in]_ptrue if the sim has been paused
virtual void gazebo::SimStateEventSource::OnUpdate ( const common::UpdateInfo _info)
virtual

Update for every time step.

Parameters
[in]_infoUpdate information provided by the server.

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