IoBuffer.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/System/Core/PimplPtr.hxx"
#include "Arp/System/Core/Endianness.hpp"
#include <memory>
 
// forwards
namespace Arp::Plc::Commons::Internal::Gds::Buffer
{
class IGdsBuffer;
} // end of namespace Arp::Plc::Commons::Internal::Gds::Buffer
 
namespace Arp::Io::Commons
{
 
class ARP_EXPORT IoBuffer
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<IoBuffer>;
    using IGdsBuffer = Arp::Plc::Commons::Internal::Gds::Buffer::IGdsBuffer;
    using IGdsBufferPtr = std::shared_ptr<IGdsBuffer>;
 
public: // canonical construction/destruction/assignment
    IoBuffer(const IoBuffer& arg) = delete;
    IoBuffer(IoBuffer&& arg)noexcept;
    IoBuffer& operator=(const IoBuffer& arg) = delete;
    IoBuffer& operator=(IoBuffer&& arg)noexcept;
    ~IoBuffer(void);
 
public: // construction
    explicit IoBuffer(IGdsBufferPtr gdsBufferPtr);
 
public: // setter/getter operations
    size_t      GetSize(void) const;
    Endianness  GetEndianness() const;
    void        SetDataValid(bool isValid = true);
 
public: // operations
    bool BeginRead(byte*& currentReadData);
    void EndRead(void);
    void BeginWrite(byte*& currentWriteData);
    void EndWrite(bool isValid = true);
 
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