TicConfiguration.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Io/Commons/Configuration/ITicSerializable.hpp"
#include "Arp/Plc/Meta/Commons/Io/PortDefinition.hpp"
 
// forwards
namespace Arp::Io::Commons::Data
{
class BufferInfo;
}
 
namespace Arp::Io::Commons::Configuration
{
 
// forwards
class TicFrame;
 
class ARP_EXPORT TicConfiguration
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using RootPtr = std::shared_ptr<ITicSerializable>;
    using ChildPtr = std::shared_ptr<ITicSerializable>;
    using Roots = std::vector<RootPtr>;
    using BufferInfo = Arp::Io::Commons::Data::BufferInfo;
    using BufferInfos = std::vector<BufferInfo>;
    using PortDefinition = Arp::Plc::Meta::Commons::Io::PortDefinition;
    using PortDefinitions = std::vector<PortDefinition>;
 
public: // canonical construction/destruction/assignment
    TicConfiguration(const TicConfiguration& arg) = delete;
    TicConfiguration(TicConfiguration&& arg)noexcept;
    TicConfiguration& operator=(const TicConfiguration& arg) = delete;
    TicConfiguration& operator=(TicConfiguration&& arg)noexcept;
    virtual ~TicConfiguration(void);
 
public: // construction
    TicConfiguration(void);
 
public: // setter/getter operations
    const Roots&           GetRoots(void)const;
    const BufferInfos&     GetBufferInfos(void)const;
    const BufferInfo&      GetBufferInfo(const String& name)const;
    bool                   TryGetBufferInfo(const String& name, BufferInfo& bufferInfo)const;
    const PortDefinitions& GetPortDefinitions(void)const;
    PortDefinitions        GetPortDefinitions(const String& bufferName)const;
 
public: // operations
    void Load(const String& ticLinksPath);
 
public: // virtual operations to override
    virtual RootPtr CreateRoot(const String& rootElementName);
    virtual bool TryCreateCustomElement(const String& elementName, ChildPtr& result);
 
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::Configuration