PhxCore.h

Go to the documentation of this file.

#ifndef PHX_CORE_H
#define PHX_CORE_H

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

// Needed util components
#include <Phx/Util/PhxListeners.h>
#include <Phx/Util/PhxLocks.h>
#include <Phx/Util/PhxLog.h>

// Core components
#include <Phx/Core/PhxNamedInterface.h>
#include <Phx/Core/PhxDescription.h>
#include <Phx/Core/PhxModule.h>
#include <Phx/Core/PhxClock.h>
#include <Phx/Core/PhxEventNotifier.h>

namespace Phx {

  class Core : public LockedPtrInterface<Core> {
  public:

    const static NamedInterface::Identifier FRAME_START_EVENT_NOTIFIER_IDENTIFIER;
    const static String FRAME_START_EVENT_NOTIFIER_NAME;

    const static NamedInterface::Identifier FRAME_END_EVENT_NOTIFIER_IDENTIFIER;
    const static String FRAME_END_EVENT_NOTIFIER_NAME;

    const static NamedInterface::Identifier QUIT_EVENT_NOTIFIER_IDENTIFIER;
    const static String QUIT_EVENT_NOTIFIER_NAME;
    
    const static NamedInterface::Identifier EXIT_EVENT_NOTIFIER_IDENTIFIER;
    const static String EXIT_EVENT_NOTIFIER_NAME;

    const static NamedInterface::Identifier WALL_CLOCK_IDENTIFIER;
    const static String WALL_CLOCK_NAME;

    const static NamedInterface::Identifier FRAME_CLOCK_IDENTIFIER;
    const static String FRAME_CLOCK_NAME;
    
    // Invoked by the program entry point.
    // This should NEVER be called by another client.
    virtual void main(void) = 0;

    // ---------  NAMED INTERFACE MANAGER ---------

    NamedInterface::Manager* namedInterfaceManager() { return mInterfaceManager.ptr(); }

    // const version of the above
    const NamedInterface::Manager* namedInterfaceManager() const { return mInterfaceManager.ptr(); }

    // --------- DESCRIPTION MANAGER ---------

    Description::Manager* descriptionManager() { return mDescriptionManager.ptr(); }

    // const version of the above
    const Description::Manager* descriptionManager() const { return mDescriptionManager.ptr(); }

    // --------- PROGRAM CONFIGURATION ---------

    virtual const String& dataPath(void) const = 0;

    virtual uint32_t threadCount(void) const = 0;

    virtual const Ptr<Log>& log(void) = 0;

    static const Ptr<Log>& systemLog(void);

    static void newCore(void);

    static Core* core(void) { return mCore; }

    static void deleteCore(void);

  protected:
    void setNamedInterfaceManager(const Ptr<NamedInterface::Manager>& manager)
      { mInterfaceManager = manager; }

    void setDescriptionManager(const Ptr<Description::Manager>& manager)
      { mDescriptionManager = manager; }

    void setCore(Core* core) {
      mCore = core;
    }
  private:
    static Core*                 mCore;
    Ptr<NamedInterface::Manager> mInterfaceManager;
    Ptr<Description::Manager>    mDescriptionManager;
  };

}; // namespace Phx

#endif /* PHX_CORE_H */

---