TimeEvent.hpp

Go to the documentation of this file.

// ANNA - Anna is Not Nothingness Anymore                                                         //
//                                                                                                //
// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
//                                                                                                //
// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //


#ifndef anna_timex_TimeEvent_hpp
#define anna_timex_TimeEvent_hpp

#include <anna/core/RuntimeException.hpp>
#include <anna/config/defines.hpp>
#include <anna/core/util/Millisecond.hpp>

namespace anna {

namespace timex {

class Engine;
class TimeEventObserver;

class TimeEvent {
public:
  typedef anna::ptrnumber Id;

  virtual ~TimeEvent();

  Id getId() const { return a_id; }

  const Millisecond & getTimeout() const { return a_timeout; }

  const TimeEventObserver* getObserver() const { return a_observer; }

  void setId(const Id id) { a_id = id; }

  void setTimeout(const Millisecond & timeout) { a_timeout = timeout; }

  void setObserver(TimeEventObserver* observer) { a_observer = observer; }

  bool isActive() const { return (a_controller != NULL); }

  virtual std::string asString() const ;

protected:
  TimeEvent() :
    a_id(0),
    a_timeout(0),
    a_controller(NULL),
    a_observer(NULL)
  {;}

  TimeEvent(const Id id, const Millisecond & timeout) :
    a_id(id),
    a_timeout(timeout),
    a_controller(NULL),
    a_observer(NULL) {}

  virtual void expire(Engine* timeController) noexcept(false) = 0;

  virtual void stop() noexcept(false) {;}

private:
  Id a_id;
  Millisecond a_timeout;
  Engine* a_controller;
  TimeEventObserver* a_observer;

  friend class Engine;
};

}
}

#endif