DataFrame.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
 
#ifndef IMT_BASE_LIB_REMOTING_DATAFRAME_H
#define IMT_BASE_LIB_REMOTING_DATAFRAME_H
 
#include <Imt.Base.Core.Platform/Nonmovable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Lib.Remoting/RemotePools.h>
#include <Imt.Base.Lib.Remoting/RemotingConfig.h>
 
namespace imt {
namespace base {
namespace lib {
namespace remoting {
 
class DataFrame final : private ::imt::base::core::platform::Nonmovable {
 
public:
 
    DataFrame();
 
    ~DataFrame();
 
    DataFrame(DataFrame const&) = delete;
    DataFrame(DataFrame&&) = delete;
    DataFrame& operator=(DataFrame const&) & = delete;
    DataFrame& operator=(DataFrame&&) & = delete;
 
    void init(DataFrame const& source);
 
    size_t getSize() const {
        return m_frameSize;
    }
 
    size_t getCapacity() const;
 
    void clear();
 
    uint8_t const* getData() const;
 
    bool append(uint8_t const ch);
 
    // AXIVION Next Codeline AutosarC++19_03-A8.4.7: Pass by value not possible for byte array.
    bool setData(uint8_t const* const pData, uint32_t const dataSize);
 
    uint8_t takeEnd();
 
    // AXIVION Next Line AutosarC++19_03-A5.1.1: default initial crc value definition
    bool appendCRC16(uint16_t const initialCrcValue = 0xFFFFU);
 
    // AXIVION Next Line AutosarC++19_03-A5.1.1: default initial crc value definition
    bool checkCRC16(uint16_t const initialCrcValue = 0xFFFFU) const;
 
    bool removeCRC16();
 
private:
 
    bool ensureIsNotFull() const;
    bool ensureTargetCapacity(size_t const targetCapacity) const;
 
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    size_t m_frameSize;
    RemotePools::DataFrameData* m_pData;
};
 
} // namespace remoting
} // namespace lib
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_LIB_REMOTING_DATAFRAME_H