IoComponentBase.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Core/Endianness.hpp"
#include "Arp/Base/Acf/Commons/ComponentBase.hpp"
#include "Arp/Plc/Domain/Commons/IPlcComponent.hpp"
#include "Arp/Plc/Meta/Commons/IIoMetaComponent.hpp"
 
namespace Arp::Io::Commons::Configuration
{
// forwards
class TicConfiguration;
}
 
namespace Arp::Io::Commons
{
// forwards
class IoLibraryBase;
class DataManager;
 
// type imports
using Arp::Base::Acf::Commons::ComponentBase;
using Arp::Plc::Domain::Commons::IPlcComponent;
using Arp::Plc::Domain::Commons::DcgResult;
using Arp::Plc::Domain::Commons::DcgResultInfo;
using Arp::Plc::Domain::Commons::PlcStartKind;
using Arp::Plc::Meta::Commons::IIoMetaComponent;
 
class ARP_EXPORT IoComponentBase
    : public ComponentBase
    , public IPlcComponent
    , public IIoMetaComponent
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using TicConfiguration = Arp::Io::Commons::Configuration::TicConfiguration;
 
public: // construction
    IoComponentBase(
        IoLibraryBase& library,
        const String& fullName,
        Endianness endianness = Endianness::Current,
        uint32 startOrderOffset = 0);
 
    // canonical construction/destruction/assignment
    IoComponentBase(const IoComponentBase& arg) = delete;
    IoComponentBase(IoComponentBase&& arg)noexcept;
    IoComponentBase& operator=(const IoComponentBase& arg) = delete;
    IoComponentBase& operator=(IoComponentBase&& arg)noexcept;
    ~IoComponentBase(void)override;
 
public: // setter/getter operations
    Endianness GetDefaultEndianness(void)const;
 
public: // IComponent operations
    void    Initialize(void)final;
    void    SubscribeServices(void)final;
    void    LoadSettings(const String& settingsPath)final;
    void    SetupSettings(void)final;
    void    PublishServices(void)final;
    void    LoadConfig(void)final;
    void    SetupConfig(void)final;
    void    ResetConfig(void)final;
    void    Dispose(void)final;
    void    PowerDown(void)final;
 
public: // IPlcComponent operations
    DcgResultInfo   LoadPlc(bool isChanging)final;
    DcgResultInfo   SetupPlc(bool isChanging, PlcStartKind startKind)final;
    void            StartPlc(PlcStartKind startKind)final;
    void            StopPlc(void)final;
    void            ResetPlc(bool isChanging, bool onError)final;
    void            UnloadPlc(bool isChanging, bool onError)final;
 
public: // IIoMetaComponent operations
    VariableRegistry& GetVariableRegistry(void)final;
 
protected: // getter/setter
    DataManager& GetDataManager(void);
 
public: // operations
    DcgResultInfo Setup(const TicConfiguration& configuration, bool isChanging = false);
 
protected: // Templated operations to override for specialized IComponent implementations
    virtual void InitializeInternal(void);
    virtual void SubscribeServicesInternal(void);
    virtual void LoadSettingsInternal(const String& settingsPath);
    virtual void SetupSettingsInternal(void);
    virtual void PublishServicesInternal(void);
    virtual void LoadConfigInternal(void);
    virtual void SetupConfigInternal(void);
    virtual void ResetConfigInternal(void);
    virtual void DisposeInternal(void);
    virtual void PowerDownInternal(void);
 
protected: // Templated operations for specializing IPlcComponent operations
    virtual DcgResultInfo   LoadPlcInternal(bool isChanging);
    virtual DcgResultInfo   SetupPlcInternal(bool isChanging, PlcStartKind startKind);
    virtual void            StartPlcInternal(PlcStartKind startKind);
    virtual void            StopPlcInternal(void);
    virtual void            ResetPlcInternal(bool isChanging, bool onError);
    virtual void            UnloadPlcInternal(bool isChanging, bool onError);
 
public: // Impl operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Io::Commons::Io