SimStateEventSource Class Reference

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

#include <SimStateEventSource.hh>

Inherits EventSource.

Public Member Functions

 SimStateEventSource (transport::PublisherPtr _pub, physics::WorldPtr _world)
 Constructor. More...
 
virtual ~SimStateEventSource ()
 Dtor. 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...
 
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...
 

Protected Attributes

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

◆ SimStateEventSource()

Constructor.

Parameters
[in]_pubpublisher for the SimEvents
[in]_worldpointer to the world.

◆ ~SimStateEventSource()

virtual ~SimStateEventSource ( )
virtual

Dtor.

Member Function Documentation

◆ Emit()

void Emit ( const std::string &  _data) const
inherited

emit an event with data to the internal publisher (and using the internal type)

Parameters
[in]_datathe JSON data related to this event.

◆ Init()

virtual void Init ( )
virtualinherited

Initialize the event.

Reimplemented in JointEventSource, and InRegionEventSource.

◆ IsActive()

virtual bool IsActive ( ) const
virtualinherited

An event source can be used to enable other events.

Inactive events do not generate an message when Emit is called.

Returns
true if the event is active

◆ Load()

virtual void 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 EventSource.

◆ OnPause()

void OnPause ( bool  _p)

Callback for the pause event.

Parameters
[in]_ptrue if the sim has been paused

◆ OnUpdate()

virtual void OnUpdate ( const common::UpdateInfo _info)
virtual

Update for every time step.

Parameters
[in]_infoUpdate information provided by the server.

Member Data Documentation

◆ active

bool active
protectedinherited

True if the event source is active.

Inactive event sources do not emit events

◆ name

std::string name
protectedinherited

Name of the event.

◆ pub

transport::PublisherPtr pub
protectedinherited

a way to send messages to the other topics (to the REST)

◆ type

std::string type
protectedinherited

Type of event.

◆ world

physics::WorldPtr world
protectedinherited

Pointer to the world.


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