##

ExistenceEventSource Class Reference

`#include <ExistenceEventSource.hh>`

Inherits EventSource.

## Public Member Functions

| ExistenceEventSource (transport::PublisherPtr _pub, physics::WorldPtr _world)
| Constructor. 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)
| Reads the model filter and event name. More...
void | OnExistence (const std::string &_model, bool _alive)
| callback for gazebo event 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...

## Constructor & Destructor Documentation

## ExistenceEventSource()

ExistenceEventSource | ( | transport::PublisherPtr | _pub,
|  | physics::WorldPtr | _world
| ) |  |

Constructor.

Parameters

  [in] | _pub | the publisher for SimEvents
  [in] | _world | the word

## 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] | _data | the JSON data related to this event.

## Init()

virtual void Init | ( |  | ) |

virtual inherited

Initialize the event.

Reimplemented in JointEventSource, and InRegionEventSource.

## IsActive()

virtual bool IsActive | ( |  | ) | const

virtual inherited

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

Reads the model filter and event name.

Parameters

  [in] | _sdf | the element for this event source

Reimplemented from EventSource.

## OnExistence()

void OnExistence | ( | const std::string & | _model,
|  | bool | _alive
| ) |  |

callback for gazebo event

Parameters

  [in] | _model | the name of the model
  [in] | _alive | true for spawn, false for delete

## Member Data Documentation

## active

bool active

protected inherited

True if the event source is active.

Inactive event sources do not emit events

## name

std::string name

protected inherited

Name of the event.

## pub

transport::PublisherPtr pub

protected inherited

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

## type

std::string type

protected inherited

Type of event.

## world

physics::WorldPtr world

protected inherited

Pointer to the world.

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

- ExistenceEventSource.hh