PhxClock.h

Go to the documentation of this file.

#ifndef PHX_CLOCK_H
#define PHX_CLOCK_H

#include <Phx/PhxConfig.h>
#include <Phx/PhxTypes.h>
#include <Phx/Core/PhxNamedInterface.h>

namespace Phx {

  class Clock : public NamedInterface {
  public:
    class Task; // Task sub-interface
    class Timer;// Timer sub-interface

    // Sub interfaces

    virtual Ptr<Task> newTask(const String& name) = 0;

    virtual Ptr<Timer> newTimer(void) = 0;

    // public attributes

    virtual double time(void) const = 0;

    virtual void time(double time) = 0;

    virtual double rate(void) const = 0;

    virtual void rate(double rate) = 0;
  };


  class Clock::Timer : public LockedPtrInterface<Clock::Timer> {
  public:
    virtual double time(void) = 0;

    virtual void time(double time) = 0;

    virtual double rate(void) const = 0;

    virtual void rate(double rate) = 0;

  };

  class Clock::Task : public LockedPtrInterface<Clock::Task> {
  public:

    const static uint32_t AFFINITY_NONE;

    const static uint32_t AFFINITY_MAIN_THREAD;


    virtual ~Task() {} // virtual destructor

    const static double NEVER;

    class Listener : public BaseListener<Clock::Task, Listener> {
    public:
      virtual void onTimeout(double scheduledTime) = 0;
    };

    virtual double nextTime(void) const = 0;

    virtual void nextTime(double nextTime) = 0;

    virtual double time(void) const = 0;

    virtual void listener(Listener* listener) = 0;

    virtual String name(void) const = 0;

    virtual void affinity(uint32_t affinity) = 0;

    virtual uint32_t affinity(void) const = 0;
  };
  
  class WallClock : public Clock {
  public:
    const static NamedInterface::Type INTERFACE_TYPE;
    const static String               INTERFACE_TYPE_NAME;
  };

  class FrameClock : public Clock {
  public:
    const static NamedInterface::Type INTERFACE_TYPE;
    const static String               INTERFACE_TYPE_NAME;
  };

}; // namespace Phx

#endif /* PHX_CLOCK_H */

---