InRegionEventSource Class Reference

The event generator class. More...

#include <InRegionEventSource.hh>

Inherits EventSource.

Public Member Functions
	InRegionEventSource (transport::PublisherPtr _pub, physics::WorldPtr _world, const std::map< std::string, RegionPtr > &_regions)
	Constructor. More...
void	Emit (const std::string &_data) const
	emit an event with data to the internal publisher (and using the internal type) 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 bool	IsActive () const
	An event source can be used to enable other events. 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...

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

The event generator class.

Constructor & Destructor Documentation

InRegionEventSource()

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

Constructor.

Parameters

[in]	_pub	the publisher for the SimEvents
[in]	_world	Pointer to the world.
[in]	_regions	dictionary of regions in the world

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.

Info()

void Info

(

)

const

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

Init()

virtual void Init ( )

virtual

Initialize the event.

Reimplemented from EventSource.

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

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

Parameters

[in]

_sdf

Reimplemented from EventSource.

Update()

void Update

(

)

Called every simulation step.

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:

• InRegionEventSource.hh