F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
ComBuffer.hpp
Go to the documentation of this file.
1 /*
2  * FwComBuffer.hpp
3  *
4  * Created on: May 24, 2014
5  * Author: tcanham
6  */
7 
8 /*
9  * Description:
10  * This object contains the ComBuffer type, used for sending and receiving packets from the ground
11  */
12 #ifndef FW_COM_BUFFER_HPP
13 #define FW_COM_BUFFER_HPP
14 
15 #include <FpConfig.hpp>
17 
18 namespace Fw {
19 
20  class ComBuffer : public SerializeBufferBase {
21  public:
22 
23  enum {
25  SERIALIZED_SIZE = FW_COM_BUFFER_MAX_SIZE + sizeof(FwBuffSizeType) // size of buffer + storage of size word
26  };
27 
28  ComBuffer(const U8 *args, NATIVE_UINT_TYPE size);
29  ComBuffer();
30  ComBuffer(const ComBuffer& other);
31  virtual ~ComBuffer();
32  ComBuffer& operator=(const ComBuffer& other);
33 
34  NATIVE_UINT_TYPE getBuffCapacity() const; // !< returns capacity, not current size, of buffer
35  U8* getBuffAddr();
36  const U8* getBuffAddr() const;
37 
38  private:
39  U8 m_bufferData[FW_COM_BUFFER_MAX_SIZE]; // packet data buffer
40  };
41 
42 }
43 
44 #endif
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:30
PlatformUIntType NATIVE_UINT_TYPE
Definition: BasicTypes.h:56
FwSizeStoreType FwBuffSizeType
Definition: FpConfig.h:452
#define FW_COM_BUFFER_MAX_SIZE
Definition: FpConfig.h:282
C++-compatible configuration header for fprime configuration.
NATIVE_UINT_TYPE getBuffCapacity() const
returns capacity, not current size, of buffer
Definition: ComBuffer.cpp:32
ComBuffer & operator=(const ComBuffer &other)
Definition: ComBuffer.cpp:22
U8 * getBuffAddr()
gets buffer address for data filling
Definition: ComBuffer.cpp:40
virtual ~ComBuffer()
Definition: ComBuffer.cpp:14