IComponent.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Acf/ILibrary.hpp"
#include "Arp/System/Acf/ComponentCategory.hpp"
#include <map>
#include <memory>

namespace Arp { namespace System { namespace Acf
{

// forwards
class IApplication;
class IControllerComponent; // for doxygen only

class IComponent
{
public: // typedefs
    typedef std::shared_ptr<IComponent>         Ptr;
    typedef std::map<String, IComponent::Ptr>   Dictionary;

protected: // construction/destruction
    IComponent(void) = default;
    virtual ~IComponent(void) = default;

public: // abstract property getter to override
    virtual IApplication&       GetApplication(void)const = 0;
    virtual ILibrary&           GetLibrary(void)const = 0;
    virtual String              GetFullName(void)const = 0;
    virtual Version             GetVersion(void)const = 0;
    virtual ComponentCategory   GetComponentCategory(void)const = 0;
    virtual uint32              GetStartOrder(void) const = 0;
    virtual bool                IsSingleton(void)const = 0;
    virtual bool                IsRequired(void)const = 0;

public: // abstract operations to override
    virtual void Initialize(void) = 0;
    virtual void SubscribeServices(void) = 0;
    virtual void LoadSettings(const String& settingsPath) = 0;
    virtual void SetupSettings(void) = 0;
    virtual void PublishServices(void) = 0;
    virtual void LoadConfig(void) = 0;
    virtual void SetupConfig(void) = 0;
    virtual void ResetConfig(void) = 0;
    virtual void Dispose(void) = 0;
    virtual void PowerDown(void) = 0;

private: // methods
    IComponent(const IComponent& arg) = delete;
    IComponent& operator=(const IComponent& arg) = delete;
};

// inline methods of class IComponent

}}} // end of namesapce Arp::System::Acf