BufferInfo.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/Io/Commons/Data/BufferType.hpp"
 
namespace Arp::Io::Commons::Data
{
 
class ARP_EXPORT BufferInfo
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<BufferInfo>;
    using BufferSize = size_t;
 
public: // canonical construction/destruction/assignment
    BufferInfo(const BufferInfo& arg);
    BufferInfo(BufferInfo&& arg)noexcept;
    BufferInfo& operator=(const BufferInfo& arg);
    BufferInfo& operator=(BufferInfo&& arg)noexcept;
    ~BufferInfo(void);
 
public: // construction
    BufferInfo(void);
    explicit BufferInfo(
        const String& name,
        BufferSize size = 0,
        BufferType type = BufferType::Data,
        Endianness endianness = Endianness::None);
 
public: // setter/getter operations
    const String&       GetName(void)const;
    BufferSize          GetSize(void)const;
    BufferType          GetType(void)const;
    Endianness          GetEndianness(void)const;
 
public: // operations
 
public: // operators
    ARP_EXPORT friend bool operator==(const BufferInfo& lhs, const BufferInfo& rhs);
 
public: // Impl operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Io::Commons::Data