BufferSerializableAc.hpp

Go to the documentation of this file.

/*
 * Buffer.hpp
 *
 *  Created on: Wednesday, 14 October 2020
 *  Author:     mstarch
 *
 */
#ifndef BUFFER_HPP_
#define BUFFER_HPP_
 
#include <Fw/Types/BasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#if FW_SERIALIZABLE_TO_STRING
#include <Fw/Types/StringType.hpp>
#include <stdio.h> // snprintf
#ifdef BUILD_UT
#include <iostream>
#include <Fw/Types/EightyCharString.hpp>
#endif
#endif
 
namespace Fw {
 
class Buffer : public Fw::Serializable {
 
 
public:
 
    enum {
        SERIALIZED_SIZE =
        sizeof(U32) +
        sizeof(U32) +
        sizeof(U64) +
        sizeof(U32)
    }; 
 
    Buffer(void); 
    Buffer(const Buffer* src); 
    Buffer(const Buffer& src); 
    Buffer(U32 managerID, U32 bufferID, U64 data, U32 size); 
    const Buffer& operator=(const Buffer& src); 
    bool operator==(const Buffer& src) const; 
#ifdef BUILD_UT
    // to support GoogleTest framework in unit tests
    friend std::ostream& operator<<(std::ostream& os, const Buffer& obj);
#endif
 
    void set(U32 managerID, U32 bufferID, U64 data, U32 size); 
 
    U32 getmanagerID(void); 
    U32 getbufferID(void); 
    U64 getdata(void); 
    U32 getsize(void); 
 
    void setmanagerID(U32 val); 
    void setbufferID(U32 val); 
    void setdata(U64 val); 
    void setsize(U32 val); 
 
 
    Fw::SerializeStatus serialize(Fw::SerializeBufferBase& buffer) const; 
    Fw::SerializeStatus deserialize(Fw::SerializeBufferBase& buffer); 
#if FW_SERIALIZABLE_TO_STRING || BUILD_UT
    void toString(Fw::StringBase& text) const; 
#endif
protected:
 
    enum {
        TYPE_ID = 0xA4583D9C 
    };
 
    U32 m_managerID; //<! managerID - The ID of the buffer manager that allocated this buffer
    U32 m_bufferID; //<! bufferID - The ID of this buffer
    U64 m_data; //<! data - A pointer to the data
    U32 m_size; //<! size - The data size in bytes
private:
 
};
} // end namespace Fw
#endif /* BUFFER_HPP_ */