Project: engagement_recognition

License: BSD

Dependencies:

Used by: None

All Packages

EventFactory Class Reference

#include <event_factory.h>

List of all members.

Static Public Member Functions

static Event completed (std::vector< std::string > additional)
static Event completed ()
static Event cycle (std::vector< std::string > additional)
static Event cycle ()
static Event failed (std::vector< std::string > additional)
static Event failed ()
static std::string getCompletedName ()
static std::string getCycleName ()
static std::string getFailedName ()
static std::string getHumanInitiatedName ()
static std::string getRobotInitiatedName ()
static std::string getSharedGazeName ()
static std::string getSuccessName ()
static Event humanInitiated (std::vector< std::string > additional)
static Event humanInitiated ()
static bool isCompleted (Event event)
static bool isCycle (Event event)
static bool isFailed (Event event)
static bool isHumanInitiated (Event event)
static bool isRobotInitiated (Event event)
static bool isSharedGaze (Event event)
static bool isSuccess (Event event)
static Event robotInitiated (std::vector< std::string > additional)
static Event robotInitiated ()
static Event sharedGaze (std::vector< std::string > additional)
static Event sharedGaze ()
static Event success (std::vector< std::string > additional)
static Event success ()

Detailed Description

This class provides a factory method which creates Event objects. It provides methods to create every type of Event.

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

Definition at line 56 of file event_factory.h.

Member Function Documentation

Event EventFactory::completed ( std::vector< std::string >  additional  )  [static]

Create a CompletedEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 72 of file event_factory.cpp.

Event EventFactory::completed (  )  [static]

Create a CompletedEvent.

Returns:
The event

Definition at line 37 of file event_factory.cpp.

Event EventFactory::cycle ( std::vector< std::string >  additional  )  [static]

Create a CycleEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 77 of file event_factory.cpp.

Event EventFactory::cycle (  )  [static]

Create a CycleEvent.

Returns:
The event

Definition at line 42 of file event_factory.cpp.

Event EventFactory::failed ( std::vector< std::string >  additional  )  [static]

Create a FailedEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 82 of file event_factory.cpp.

Event EventFactory::failed (  )  [static]

Create a FailedEvent.

Returns:
The event

Definition at line 47 of file event_factory.cpp.

std::string EventFactory::getCompletedName (  )  [static]

Return the name of the CompletedEvent.

Returns:
The name

Definition at line 142 of file event_factory.cpp.

std::string EventFactory::getCycleName (  )  [static]

Return the name of the CycleEvent.

Returns:
The name

Definition at line 147 of file event_factory.cpp.

std::string EventFactory::getFailedName (  )  [static]

Return the name of the FailedEvent.

Returns:
The name

Definition at line 152 of file event_factory.cpp.

std::string EventFactory::getHumanInitiatedName (  )  [static]

Return the name of the HumanInitiatedEvent.

Returns:
The name

Definition at line 157 of file event_factory.cpp.

std::string EventFactory::getRobotInitiatedName (  )  [static]

Return the name of the RobotInitiatedEvent.

Returns:
The name

Definition at line 162 of file event_factory.cpp.

std::string EventFactory::getSharedGazeName (  )  [static]

Return the name of the SharedGazeEvent.

Returns:
The name

Definition at line 167 of file event_factory.cpp.

std::string EventFactory::getSuccessName (  )  [static]

Return the name of the SuccessEvent.

Returns:
The name

Definition at line 172 of file event_factory.cpp.

Event EventFactory::humanInitiated ( std::vector< std::string >  additional  )  [static]

Create a HumanInitiatedEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 87 of file event_factory.cpp.

Event EventFactory::humanInitiated (  )  [static]

Create a HumanInitiatedEvent.

Returns:
The event

Definition at line 52 of file event_factory.cpp.

bool EventFactory::isCompleted ( Event  event  )  [static]

Determine if this event is a CompletedEvent.

Parameters:
event The event
Returns:
True if the event is a CompletedEvent

Definition at line 107 of file event_factory.cpp.

bool EventFactory::isCycle ( Event  event  )  [static]

Determine if this event is a CycleEvent.

Parameters:
event The event
Returns:
True if the event is a CycleEvent

Definition at line 112 of file event_factory.cpp.

bool EventFactory::isFailed ( Event  event  )  [static]

Determine if this event is a FailedEvent.

Parameters:
event The event
Returns:
True if the event is a FailedEvent

Definition at line 117 of file event_factory.cpp.

bool EventFactory::isHumanInitiated ( Event  event  )  [static]

Determine if this event is a HumanInitiatedEvent.

Parameters:
event The event
Returns:
True if the event is a HumanInitiatedEvent

Definition at line 122 of file event_factory.cpp.

bool EventFactory::isRobotInitiated ( Event  event  )  [static]

Determine if this event is a RobotInitiatedEvent.

Parameters:
event The event
Returns:
True if the event is a RobotInitiatedEvent

Definition at line 127 of file event_factory.cpp.

bool EventFactory::isSharedGaze ( Event  event  )  [static]

Determine if this event is a SharedGazeEvent.

Parameters:
event The event
Returns:
True if the event is a SharedGazeEvent

Definition at line 132 of file event_factory.cpp.

bool EventFactory::isSuccess ( Event  event  )  [static]

Determine if this event is a SuccessEvent.

Parameters:
event The event
Returns:
True if the event is a SuccessEvent

Definition at line 137 of file event_factory.cpp.

Event EventFactory::robotInitiated ( std::vector< std::string >  additional  )  [static]

Create a RobotInitiatedEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 92 of file event_factory.cpp.

Event EventFactory::robotInitiated (  )  [static]

Create a RobotInitiatedEvent.

Returns:
The event

Definition at line 57 of file event_factory.cpp.

Event EventFactory::sharedGaze ( std::vector< std::string >  additional  )  [static]

Create a SharedGazeEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 97 of file event_factory.cpp.

Event EventFactory::sharedGaze (  )  [static]

Create a SharedGazeEvent.

Returns:
The event

Definition at line 62 of file event_factory.cpp.

Event EventFactory::success ( std::vector< std::string >  additional  )  [static]

Create a SuccessEvent.

Parameters:
additional The additional data
Returns:
The event

Definition at line 102 of file event_factory.cpp.

Event EventFactory::success (  )  [static]

Create a SuccessEvent.

Returns:
The event

Definition at line 67 of file event_factory.cpp.

The documentation for this class was generated from the following files:
engagement_recognition
Author(s): Brett Ponsler (bponsler (at) wpi (dot) edu)
autogenerated on Fri Sep 9 10:35:49 2011