IComponent.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/ArpVersion.hpp"
#include "Arp/Base/Acf/Commons/ComponentCategory.hpp"
#include "Arp/Base/Acf/Commons/ComponentInfoKind.hpp"
 
namespace Arp::Base::Acf::Commons
{
 
// forwards
class ILibrary;
class Application;
class IControllerComponent; // for doxygen only, caused by see-also hint
 
class ARP_EXPORT IComponent
{
public: // usings
 
    using Ptr = std::shared_ptr<IComponent>;
 
protected: // construction/destruction
 
    IComponent(void) = default;
 
public: // construction/destruction
 
    IComponent(IComponent&& arg)noexcept = default;
 
    IComponent(const IComponent& arg) = delete;
 
    IComponent& operator=(IComponent&& arg)noexcept = default;
 
    IComponent& operator=(const IComponent& arg) = delete;
 
    virtual ~IComponent(void) = default;
 
public: // abstract property getter to override
 
    virtual Application& GetApplication(void)const = 0;
 
    virtual ILibrary& GetLibrary(void)const = 0;
 
    virtual String GetFullName(void)const = 0;
 
    virtual ComponentCategory GetComponentCategory(void)const = 0;
 
    virtual uint32 GetStartOrder(void)const = 0;
 
    virtual bool IsRequired(void)const = 0;
 
    virtual String GetComponentInfoItem(ComponentInfoKind kind) 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;
};
 
} // end of namespace Arp::System::Acf::Commons
 
namespace Arp::System::Acf
{
using Arp::Base::Acf::Commons::IComponent;
}