TicFrame.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/BitSize.hpp"
 
namespace Arp::Io::Commons::Data
{
class BufferInfo;
}
 
namespace Arp::Io::Commons::Configuration
{
 
class TicPort;
 
class ARP_EXPORT TicFrame : public TicBase
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<TicFrame>;
    using ConstPtr = std::shared_ptr<const TicFrame>;
    using PortPtr = std::shared_ptr<TicPort>;
    using BufferInfo = Arp::Io::Commons::Data::BufferInfo;
    using BitSize = Arp::Plc::Meta::Commons::BitSize;
 
public: // canonical construction/destruction/assignment
    TicFrame(const TicFrame& arg) = delete;
    TicFrame(TicFrame&& arg)noexcept;
    TicFrame& operator=(const TicFrame& arg) = delete;
    TicFrame& operator=(TicFrame&& arg)noexcept;
    ~TicFrame(void)override;
 
public: // construction
    TicFrame(void);
 
public: // static operations
    static const char* GetTicElementName(void);
 
public: // setter/getter operations
    const String& GetFrameID(void)const noexcept;
    BitSize GetLength(void)const noexcept;
    const BufferInfo& GetBufferInfo(void)const;
 
public: // operations
    bool TryReadAttribute(TicReader& reader, const String& attributeName)final;
    bool TryCreateElement(const String& elementName, ChildPtr& result)final;
    void OnReadEnd(void)override;
 
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