EventSource Class Reference

The base class for emitting SimEvents. More...

#include <EventSource.hh>

Inherited by ExistenceEventSource, InRegionEventSource, JointEventSource, OccupiedEventSource, and SimStateEventSource.

Public Member Functions
	EventSource (transport::PublisherPtr _pub, const std::string &_type, physics::WorldPtr _world)
	Constructor.
virtual	~EventSource ()
	Destructor.
void	Emit (const std::string &_data) const
	emit an event with data to the internal publisher (and using the internal type)
virtual void	Init ()
	Initialize the event.
virtual bool	IsActive () const
	An event source can be used to enable other events.
virtual void	Load (const sdf::ElementPtr _sdf)
	Load from an sdf element (with possible configuration data)

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

Detailed Description

The base class for emitting SimEvents.

Constructor & Destructor Documentation

EventSource()

EventSource	(	transport::PublisherPtr	_pub,
		const std::string &	_type,
		physics::WorldPtr	_world )

Constructor.

Parameters

[in]	_pub	the publisher where the events are emitted
[in]	_type	the type of event
[in]	_world	Pointer to the world (in order to get model refs, etc)

~EventSource()

virtual ~EventSource ( )

virtual

Destructor.

Member Function Documentation

Emit()

void Emit

(

const std::string &

_data

)

const

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

Initialize the event.

Reimplemented in InRegionEventSource, and JointEventSource.

IsActive()

virtual bool IsActive ( ) const

virtual

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 from an sdf element (with possible configuration data)

Parameters

[in]

_sdf

the sdf element for the event in the world file

Reimplemented in ExistenceEventSource, InRegionEventSource, JointEventSource, OccupiedEventSource, and SimStateEventSource.

Member Data Documentation

active

bool active

protected

True if the event source is active.

Inactive event sources do not emit events

name

std::string name

protected

Name of the event.

pub

transport::PublisherPtr pub

protected

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

type

std::string type

protected

Type of event.

world

physics::WorldPtr world

protected

Pointer to the world.

---

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

• EventSource.hh