Project: engagement_recognition

License: BSD

Dependencies:

Used by: None

All Packages

Event Class Reference

#include <event.h>

Inheritance diagram for Event:

List of all members.

Public Member Functions

 Event (std::string name, std::vector< std::string > additional)
 Event (std::string name)
 Event ()
std::vector< std::string > getAdditional ()
std::string getName ()

Private Attributes

std::vector< std::string > additional_
std::string name_

Detailed Description

The Event class encapsulates a single event.

This class is responsible for providing the foundation for a single event. Each Event has an associated name and additional information.

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

Definition at line 50 of file event.h.


Constructor & Destructor Documentation

Event::Event (  ) 

Default constructor for the Event.

Definition at line 38 of file event.cpp.

Event::Event ( std::string  name  ) 

Constructor for the Event, takes a name.

Parameters:
name The name of the event

Definition at line 45 of file event.cpp.

Event::Event ( std::string  name,
std::vector< std::string >  additional 
)

Constructor for the Event, takes a name and additional_ data.

Parameters:
name The name of the event
additional The additional information

Definition at line 52 of file event.cpp.


Member Function Documentation

std::vector< std::string > Event::getAdditional (  ) 

Return the additional_ data for the Event.

Returns:
The additional data

Definition at line 64 of file event.cpp.

std::string Event::getName (  ) 

Return the name of the Event.

Returns:
The name of the event

Definition at line 59 of file event.cpp.


Member Data Documentation

std::vector<std::string> Event::additional_ [private]

The additional information associated with this Event.

Definition at line 57 of file event.h.

std::string Event::name_ [private]

The name of the Event.

Definition at line 54 of file event.h.


The documentation for this class was generated from the following files:
  • engagement_recognition/src/recognition/events/event.h
  • engagement_recognition/src/recognition/events/event.cpp

engagement_recognition
Author(s): Brett Ponsler (bponsler (at) wpi (dot) edu)
autogenerated on Fri Sep 9 10:35:49 2011