Homepage | Demos | Overview | Downloads | Tutorials | Reference | Credits |
#include <EventBase.h>
Inheritance diagram for EventBase:
Contains the list of 'known' event generators in EventGeneratorID_t and EventGeneratorNames[]. If you want to make a new generator, all you have to do is add a new entry to the ID list (EventGeneratorID_t) and then put it's name in the EventGeneratorNames[] array.
Alternatively, there is an 'unlicensed spectrum' available under the unknownEGID. You can send out events from that generator just like any other, but it should only be used for quick tests and hacking around...
The SourceID is generator specific. A SID of i from the button generator will refer to a particular button, whereas a SID from vision refers to seeing a particular object. These SIDs are usually defined in the generators themselves. See the EventGeneratorID_t list for links to the generators.
The duration field is also generator specific - some may refer to the time since the last activation event (e.g. button events) where as others refer to time since last status (e.g. sensors updates)
Definition at line 31 of file EventBase.h.
Public Types | |
enum | EventGeneratorID_t { unknownEGID = 0, visionEGID, buttonEGID, worldModelEGID, aiEGID, audioEGID, sensorEGID, powerEGID, timerEGID, stateMachineEGID, locomotionEGID, textmsgEGID, estopEGID, motmanEGID, numEGIDs } |
Lists all possible event generator ids. More... | |
enum | EventTypeID_t { activateETID, statusETID, deactivateETID, numETIDs } |
an event type id is used to denote whether it's the first in a sequence (button down), in a sequence (button still down), or last (button up) More... | |
Public Member Functions | |
Constructors/Destructors | |
EventBase () | |
constructor | |
EventBase (EventGeneratorID_t gid, unsigned int sid, EventTypeID_t tid, unsigned int dur=0) | |
constructor | |
EventBase (EventGeneratorID_t gid, unsigned int sid, EventTypeID_t tid, unsigned int dur, const std::string &n, float mag) | |
constructor | |
virtual | ~EventBase () |
destructor | |
Methods | |
virtual const std::string & | getName () const |
gets the name of the event - useful for debugging, outputs | |
virtual EventBase & | setName (const std::string &n) |
sets name to a given string, prevents overwriting by generated names | |
virtual float | getMagnitude () const |
gets "strength" of event - you might have useful values... used by AI | |
virtual EventBase & | setMagnitude (float m) |
sets "strength" of event - but you might have useful values... used by AI | |
virtual unsigned int | getTimeStamp () const |
time event was created | |
virtual EventGeneratorID_t | getGeneratorID () const |
gets the generator ID for this event | |
virtual EventBase & | setGeneratorID (EventGeneratorID_t gid) |
sets the generator ID for this event | |
virtual unsigned int | getSourceID () const |
gets the source ID for this event | |
virtual EventBase & | setSourceID (unsigned int gid) |
sets the source ID for this event | |
virtual EventTypeID_t | getTypeID () const |
gets the type ID | |
virtual EventBase & | setTypeID (EventTypeID_t tid) |
sets the type ID | |
virtual unsigned int | getDuration () const |
OPTIONAL gets the time since the beginning of this sequence (the timestamp of the activate event). | |
virtual EventBase & | setDuration (unsigned int d) |
OPTIONAL gets the time since the beginning of this sequence (the timestamp of the activate event). | |
virtual const std::string & | resetName () |
resets name to generated form, overwriting any previous name | |
virtual bool | isCustomName () const |
returns true if not using the generated name | |
bool | operator< (const EventBase &e) const |
gets the name of the event - useful for debugging, outputs | |
virtual bool | operator== (const EventBase &eb) const |
is true if the genID, typeID, and sourceID's all match | |
bool | sameGenSource (const EventBase eb) const |
tests to see if events have the same generator and source IDs | |
bool | longerThan (const EventBase eb) const |
compares event duration and ensures same event generator, source, and type - useful for event masks | |
bool | shorterThan (const EventBase eb) const |
compares event duration and ensures same event generator, source, and type - useful for event masks | |
bool | equalOrLongerThan (const EventBase eb) const |
compares event duration and ensures same event generator, source, and type - useful for event masks | |
bool | equalOrShorterThan (const EventBase eb) const |
compares event duration and ensures same event generator, source, and type - useful for event masks | |
LoadSave interface | |
Useful for serializing events to send between processes | |
virtual unsigned int | getBinSize () const |
calculates space needed to save - if you can't precisely add up the size, overestimate and things will still work. | |
virtual unsigned int | LoadBuffer (const char buf[], unsigned int len) |
Load from a saved buffer. | |
virtual unsigned int | SaveBuffer (char buf[], unsigned int len) const |
Save to a given buffer. | |
Static Public Attributes | |
const char *const | EventGeneratorNames [numEGIDs] |
Holds string versions of each of the generator's names, handy for debugging so you can output the events as readable strings. | |
Protected Member Functions | |
virtual void | genName () |
This does the actual generation of names based on genID, sourceID, and typeID. | |
Protected Attributes | |
std::string | stim_id |
the name of the event, use the same name consistently or else will be seen as different stimuli | |
float | magnitude |
the current "strength" of the event/stimuli... MAKE SURE this gets set to ZERO IF event is DEACTIVATE | |
unsigned int | timestamp |
the time the event was created - set automatically by constructor | |
bool | nameisgen |
tracks whether the current name (stim_id) is generated or set | |
EventGeneratorID_t | genID |
generator ID,
| |
EventTypeID_t | typeID |
type ID,
| |
unsigned int | sourceID |
the source ID for this event Source IDs are defined by the generator that made it | |
unsigned int | duration |
the time since this sequence started (like, how long the button has been pressed) ideally, this would be 0 for activate, (activate.timestamp-get_time()) for status and deactivate |
|
Lists all possible event generator ids. An event generator is a abstract source of events, used for listening to and parsing certain classes of events IF YOU ADD AN EVENT GENERATOR, DON'T FORGET TO NAME IT (EventBase::EventGeneratorNames, below)
Definition at line 37 of file EventBase.h. |
|
an event type id is used to denote whether it's the first in a sequence (button down), in a sequence (button still down), or last (button up)
Definition at line 59 of file EventBase.h. |
|
constructor
Definition at line 22 of file EventBase.cc. References genName(), and get_time(). |
|
constructor
Definition at line 28 of file EventBase.cc. References deactivateETID, genName(), get_time(), and setMagnitude(). |
|
constructor
Definition at line 38 of file EventBase.cc. References get_time(). |
|
destructor
Definition at line 72 of file EventBase.h. |
|
compares event duration and ensures same event generator, source, and type - useful for event masks
Definition at line 110 of file EventBase.h. References duration, and operator==(). |
|
compares event duration and ensures same event generator, source, and type - useful for event masks
Definition at line 111 of file EventBase.h. References duration, and operator==(). |
|
This does the actual generation of names based on genID, sourceID, and typeID.
Definition at line 114 of file EventBase.cc. References EventGeneratorNames, genID, nameisgen, numEGIDs, sourceID, and stim_id. |
|
calculates space needed to save - if you can't precisely add up the size, overestimate and things will still work.
Implements LoadSave. Reimplemented in LocomotionEvent, TextMsgEvent, and VisionEvent. Definition at line 46 of file EventBase.cc. References LoadSave::creatorSize(), duration, magnitude, nameisgen, sourceID, stim_id, LoadSave::stringpad, and timestamp. |
|
OPTIONAL gets the time since the beginning of this sequence (the timestamp of the activate event).
Definition at line 93 of file EventBase.h. References duration. |
|
gets the generator ID for this event
Definition at line 84 of file EventBase.h. References EventGeneratorID_t, and genID. |
|
gets "strength" of event - you might have useful values... used by AI
Definition at line 79 of file EventBase.h. References magnitude. |
|
gets the name of the event - useful for debugging, outputs
Definition at line 76 of file EventBase.h. References stim_id. |
|
gets the source ID for this event
Definition at line 87 of file EventBase.h. References sourceID. |
|
time event was created
Definition at line 82 of file EventBase.h. References timestamp. |
|
gets the type ID
Definition at line 90 of file EventBase.h. References EventTypeID_t, and typeID. |
|
returns true if not using the generated name
Definition at line 97 of file EventBase.h. References nameisgen. |
|
Load from a saved buffer.
Implements LoadSave. Reimplemented in LocomotionEvent, TextMsgEvent, and VisionEvent. Definition at line 61 of file EventBase.cc. References LoadSave::checkCreator(), LoadSave::decode(), duration, EventGeneratorID_t, EventTypeID_t, genID, magnitude, nameisgen, sourceID, stim_id, timestamp, and typeID. |
|
compares event duration and ensures same event generator, source, and type - useful for event masks
Definition at line 108 of file EventBase.h. References duration, and operator==(). |
|
gets the name of the event - useful for debugging, outputs
Definition at line 99 of file EventBase.h. References timestamp. |
|
is true if the genID, typeID, and sourceID's all match
Definition at line 102 of file EventBase.h. |
|
resets name to generated form, overwriting any previous name
Definition at line 96 of file EventBase.h. |
|
tests to see if events have the same generator and source IDs
Definition at line 106 of file EventBase.h. |
|
Save to a given buffer.
Implements LoadSave. Reimplemented in LocomotionEvent, TextMsgEvent, and VisionEvent. Definition at line 89 of file EventBase.cc. References duration, LoadSave::encode(), genID, magnitude, nameisgen, LoadSave::saveCreator(), sourceID, stim_id, timestamp, and typeID. |
|
OPTIONAL gets the time since the beginning of this sequence (the timestamp of the activate event).
Definition at line 94 of file EventBase.h. References duration. |
|
sets the generator ID for this event
Definition at line 85 of file EventBase.h. |
|
sets "strength" of event - but you might have useful values... used by AI
Definition at line 80 of file EventBase.h. References magnitude. |
|
sets name to a given string, prevents overwriting by generated names
Definition at line 77 of file EventBase.h. |
|
sets the source ID for this event
Definition at line 88 of file EventBase.h. |
|
sets the type ID
Definition at line 91 of file EventBase.h. |
|
compares event duration and ensures same event generator, source, and type - useful for event masks
Definition at line 109 of file EventBase.h. References duration, and operator==(). |
|
the time since this sequence started (like, how long the button has been pressed) ideally, this would be 0 for activate, (activate.timestamp-get_time()) for status and deactivate
Definition at line 134 of file EventBase.h. |
|
Initial value: { "UnknownGen", "Vision", "Button", "WorldModel", "AI", "Audio", "Sensor", "Power", "Timer", "StateMachine", "Locomotion", "TextMsg", "EStop", "MotionManager" }
Definition at line 4 of file EventBase.cc. |
|
generator ID,
Definition at line 128 of file EventBase.h. |
|
the current "strength" of the event/stimuli... MAKE SURE this gets set to ZERO IF event is DEACTIVATE
Definition at line 122 of file EventBase.h. |
|
tracks whether the current name (stim_id) is generated or set
Definition at line 125 of file EventBase.h. |
|
the source ID for this event Source IDs are defined by the generator that made it This should give authors flexibility to design their modules without having to worry about ID space collision Definition at line 130 of file EventBase.h. |
|
the name of the event, use the same name consistently or else will be seen as different stimuli
Definition at line 121 of file EventBase.h. |
|
the time the event was created - set automatically by constructor
Definition at line 123 of file EventBase.h. |
|
type ID,
Definition at line 129 of file EventBase.h. |
Tekkotsu v1.4 |
Generated Sat Jul 19 00:08:55 2003 by Doxygen 1.3.2 |