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

The event generator class. More...

#include <InRegionEventSource.hh>

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

Public Member Functions

 InRegionEventSource (transport::PublisherPtr _pub, physics::WorldPtr _world, const std::map< std::string, RegionPtr > &_regions)
 Constructor. More...
 
void Info () const
 Prints data about the event source to the log (useful for debug) More...
 
virtual void Init ()
 Initialize the event. More...
 
virtual void Load (const sdf::ElementPtr _sdf)
 Loads the full name of the model and the region from the world file. More...
 
void Update ()
 Called every simulation 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 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

The event generator class.

Constructor & Destructor Documentation

gazebo::InRegionEventSource::InRegionEventSource ( transport::PublisherPtr  _pub,
physics::WorldPtr  _world,
const std::map< std::string, RegionPtr > &  _regions 
)

Constructor.

Parameters
[in]_pubthe publisher for the SimEvents
[in]_worldPointer to the world.
[in]_regionsdictionary of regions in the world

Member Function Documentation

void gazebo::InRegionEventSource::Info ( ) const

Prints data about the event source to the log (useful for debug)

virtual void gazebo::InRegionEventSource::Init ( )
virtual

Initialize the event.

Reimplemented from gazebo::EventSource.

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

Loads the full name of the model and the region from the world file.

Parameters
[in]_sdf

Reimplemented from gazebo::EventSource.

void gazebo::InRegionEventSource::Update ( )

Called every simulation step.


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