EventSink Class Reference

#include <event_sink.h>

Inheritance diagram for EventSink:

[legend]

List of all members.

Public Member Functions
virtual void	castEvent (Event event)=0
virtual bool	compareAdditional (std::vector< std::string > additional, std::string compare)=0
	EventSink (EventSink *parent)
	EventSink ()
EventSink *	getParent ()
virtual	~EventSink ()
Protected Attributes
EventSink *	parent_
Static Protected Attributes
static const std::string	CONTAINS = "CONTAINS"

---

Detailed Description

The EventSink class is responsible for providing an interface where Events can be cast and handled appropriately.

Author:

Brett Ponsler (bponsler (at) wpi (dot) edu)

Definition at line 48 of file event_sink.h.

---

Constructor & Destructor Documentation

EventSink::~EventSink

(

)

[virtual]

Deconstructor for the EventSink class.

Definition at line 40 of file event_sink.cpp.

EventSink::EventSink

(

)

Default constructor for the EventSink object.

Definition at line 45 of file event_sink.cpp.

EventSink::EventSink

(

EventSink *

parent

)

Constructor for the EventSink class, takes a parent EventSink object.

Parameters:

parent

The parent EventSink

Definition at line 51 of file event_sink.cpp.

---

Member Function Documentation

virtual void EventSink::castEvent

(

Event

event

)

[pure virtual]

Method responsible for casting an Event.

This function is responsible for casting a single Event which contains additional information associated with it.

Parameters:

event

The event that has been cast

Implemented in EngagementHandler, Recognizer, RNode, and State.

virtual bool EventSink::compareAdditional	(	std::vector< std::string >	additional,
		std::string	compare
	)			[pure virtual]

Compare the additional data as specified.

Parameters:

	additional	The additional data
	compare	How to compare the data

Returns:

Success of the comparison

Implemented in EngagementHandler, Recognizer, RNode, and State.

EventSink * EventSink::getParent

(

)

Return the parent of this EventSink object.

Returns:

The parent

Definition at line 62 of file event_sink.cpp.

---

Member Data Documentation

const std::string EventSink::CONTAINS = "CONTAINS" [static, protected]

Compare the additional data to see if it contains an object.

Definition at line 55 of file event_sink.h.

EventSink* EventSink::parent_ [protected]

The parent EventSink object. Allows chaining of events.

Definition at line 52 of file event_sink.h.

---

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

• engagement_recognition/src/recognition/events/event_sink.h
• engagement_recognition/src/recognition/events/event_sink.cpp