Ginga  0.13.6.2086-83aa
The iTV middleware.
Event Class Reference

Event state machine. More...

#include <Event.h>

Collaboration diagram for Event:

Public Types

enum  Type { ATTRIBUTION = 0, PRESENTATION, SELECTION }
 Event type. More...
 
enum  State { OCCURRING = 0, PAUSED, SLEEPING }
 Event state. More...
 
enum  Transition {
  ABORT = 0, PAUSE, RESUME, START,
  STOP
}
 Event state transitions. More...
 

Public Member Functions

 Event (Event::Type, Object *, const string &id)
 
Event::Type getType ()
 
ObjectgetObject ()
 
string getId ()
 
string getFullId ()
 
Event::State getState ()
 
string toString ()
 
bool isLambda ()
 
void getInterval (Time *, Time *)
 
void setInterval (Time, Time)
 
bool hasLabel ()
 
std::string getLabel ()
 
void setLabel (const std::string &)
 
bool getParameter (const string &, string *)
 
bool setParameter (const string &, const string &)
 
bool transition (Event::Transition)
 Transitions event. More...
 
void reset ()
 

Static Public Member Functions

static string getEventTypeAsString (Event::Type)
 
static string getEventStateAsString (Event::State)
 
static string getEventTransitionAsString (Event::Transition)
 

Private Attributes

Event::Type _type
 Event type.
 
Object_object
 Target object.
 
string _id
 Event id.
 
Event::State _state
 Event state.
 
Time _begin
 Begin time.
 
Time _end
 End time.
 
std::string _label
 Label.
 
map< string, string > _parameters
 Parameters.
 

Detailed Description

Event state machine.

Member Enumeration Documentation

◆ State

Event state.

Enumerator
OCCURRING 

Occurring.

PAUSED 

Paused.

SLEEPING 

Sleeping.

◆ Transition

Event state transitions.

Enumerator
ABORT 

Abort.

PAUSE 

Pause.

RESUME 

Resume.

START 

Start.

STOP 

Stop.

◆ Type

Event type.

Enumerator
ATTRIBUTION 

Attribution event.

Stands for the attribution of some value to a specific property of the object.

PRESENTATION 

Presentation event.

Stands for the presentation of a specific time interval of the object.

SELECTION 

Selection event.

Stands for the pressing or releasing of a specific key which is directed to the object.

Member Function Documentation

◆ transition()

bool Event::transition ( Event::Transition  trans)

Transitions event.

Parameters
transThe desired transition.
Returns
true if successful, or false otherwise.

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