SerialBuffer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SerialBuffer.hpp
// \author bocchino
// \brief  hpp file for SerialBuffer type
//
// \copyright
// Copyright (C) 2016 California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Fw_SerialBuffer_HPP
#define Fw_SerialBuffer_HPP

#include <Fw/FPrimeBasicTypes.hpp>
#include "Fw/Types/Serializable.hpp"

namespace Fw {

class SerialBuffer final : public SerializeBufferBase {
  public:
    // ----------------------------------------------------------------------
    // Construction
    // ----------------------------------------------------------------------

    SerialBuffer(U8* const data,            
                 const FwSizeType capacity  
    );

  public:
    // ----------------------------------------------------------------------
    // Pure virtual methods from SerializeBufferBase
    // ----------------------------------------------------------------------

    DEPRECATED(FwSizeType getBuffCapacity() const, "Use getCapacity() instead");
    FwSizeType getCapacity() const;

    U8* getBuffAddr();

    const U8* getBuffAddr() const;

  public:
    // ----------------------------------------------------------------------
    // Public instance methods
    // ----------------------------------------------------------------------

    void fill();

    SerializeStatus pushBytes(const U8* const addr,  
                              const FwSizeType n     
    );

    SerializeStatus popBytes(U8* const addr,  
                             FwSizeType n     
    );

  private:
    // ----------------------------------------------------------------------
    // Data
    // ----------------------------------------------------------------------

    U8* const m_data;

    const FwSizeType m_capacity;
};

}  // namespace Fw

#endif