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/Types/BasicTypes.hpp"
#include "Fw/Types/Serializable.hpp"
 
namespace Fw {
 
  class SerialBuffer :
    public SerializeBufferBase
  {
 
    public:
 
      // ----------------------------------------------------------------------
      // Construction 
      // ----------------------------------------------------------------------
 
      SerialBuffer(
          U8 *const data, 
          const U32 capacity 
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Pure virtual methods from SerializeBufferBase
      // ----------------------------------------------------------------------
 
      NATIVE_UINT_TYPE getBuffCapacity(void) const;
 
      U8* getBuffAddr(void);
 
      const U8* getBuffAddr(void) const;
 
    public:
 
      // ----------------------------------------------------------------------
      // Public instance methods 
      // ----------------------------------------------------------------------
 
      void fill(void);
 
      SerializeStatus pushBytes(
          const U8 *const addr, 
          const NATIVE_UINT_TYPE n 
      );
 
      SerializeStatus popBytes(
          U8 *const addr, 
          NATIVE_UINT_TYPE n 
      );
 
    private:
 
      // ----------------------------------------------------------------------
      // Data 
      // ----------------------------------------------------------------------
 
      U8 *const data;
 
      const U32 capacity;
 
  };
 
}
 
#endif