Event.h

/* Copyright (C) 2006-2018 PUC-Rio/Laboratorio TeleMidia

This file is part of Ginga (Ginga-NCL).

Ginga is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

Ginga is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
License for more details.

You should have received a copy of the GNU General Public License
along with Ginga.  If not, see <https://www.gnu.org/licenses/>.  */

#ifndef EVENT_H
#define EVENT_H

#include "aux-ginga.h"
#include "Predicate.h"

GINGA_NAMESPACE_BEGIN

class Object;

class Event
{
public:

  enum Type
  {
    ATTRIBUTION = 0,

    PRESENTATION,

    SELECTION,
  };

  enum State
  {
    OCCURRING = 0,              
    PAUSED,                     
    SLEEPING,                   
  };

  enum Transition
  {
    ABORT = 0,                  
    PAUSE,                      
    RESUME,                     
    START,                      
    STOP,                       
  };

  Event (Event::Type, Object *, const string &id);
  ~Event ();

  Event::Type getType ();
  Object *getObject ();
  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);
  void reset ();

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

private:
  Event::Type _type;               
  Object *_object;                 
  string _id;                      
  Event::State _state;             
  Time _begin;                     
  Time _end;                       
  std::string _label;              
  map<string, string> _parameters; 
};

typedef struct
{
  Event *event;                 
  Event::Transition transition; 
  Predicate *predicate;         
  string value;                 
  string duration;              
} Action;

GINGA_NAMESPACE_END

#endif // EVENT_H