TicPort.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/TicBase.hpp"
#include "Arp/Plc/Meta/Commons/Io/PortDefinition.hpp"
 
namespace Arp::Io::Commons::Configuration
{
 
class ARP_EXPORT TicPort : public TicBase
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<TicPort>;
    using ConstPtr = std::shared_ptr<const TicPort>;
    using PortDefinition = Arp::Plc::Meta::Commons::Io::PortDefinition;
    using NodeID = Arp::uint32;
    using DataType = Arp::Plc::Meta::Commons::DataType;
    using BitSize = Arp::Plc::Meta::Commons::BitSize;
 
public: // canonical construction/destruction/assignment
    TicPort(const TicPort& arg) = delete;
    TicPort(TicPort&& arg)noexcept;
    TicPort& operator=(const TicPort& arg) = delete;
    TicPort& operator=(TicPort&& arg)noexcept;
    ~TicPort(void) override;
 
public: // construction
    TicPort(void);
 
public: // static operations
    static const char* GetTicElementName(void);
 
public: // setter/getter operations
    NodeID GetNodeID(void)const noexcept;
    const String& GetName(void)const noexcept;
    DataType GetDataType(void)const noexcept;
    BitSize GetLength(void)const noexcept;
    BitSize GetOffset(void)const noexcept;
 
public: // TicBase operations
    bool TryReadAttribute(TicReader& reader, const String& attributeName)final;
    bool TryCreateElement(const String& elementName, ChildPtr& result)final;
    void OnReadEnd(void)override;
 
public: // operations
    PortDefinition CreatePortDefinition(const String& bufferName) const;
 
public: // Impl operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
ARP_EXPORT bool operator==(const TicPort& lhs, const TicPort& rhs);
ARP_EXPORT bool operator<(const TicPort& lhs, const TicPort& rhs);
 
} // end of namespace Arp::Io::Commons::Configuration