F´ Flight Software - C/C++ Documentation  NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
TlmBuffer.hpp
Go to the documentation of this file.
1 /*
2  * TlmBuffer.hpp
3  *
4  * Author: tcanham
5  */
6 
7 /*
8  * Description:
9  * This object contains the TlmBuffer type, used for storing telemetry
10  */
11 #ifndef FW_TLM_BUFFER_HPP
12 #define FW_TLM_BUFFER_HPP
13 
14 #include <FpConfig.hpp>
15 #include <Fw/Types/BasicTypes.hpp>
16 #include <Fw/Types/Serializable.hpp>
17 #include <Fw/Cfg/SerIds.hpp>
18 
19 namespace Fw {
20 
21  class TlmBuffer : public SerializeBufferBase {
22  public:
23 
24  enum {
27  };
28 
29  TlmBuffer(const U8 *args, NATIVE_UINT_TYPE size);
30  TlmBuffer();
31  TlmBuffer(const TlmBuffer& other);
32  virtual ~TlmBuffer();
33  TlmBuffer& operator=(const TlmBuffer& other);
34 
35  NATIVE_UINT_TYPE getBuffCapacity() const; // !< returns capacity, not current size, of buffer
36  U8* getBuffAddr();
37  const U8* getBuffAddr() const;
38 
39  PRIVATE:
40  U8 m_bufferData[FW_TLM_BUFFER_MAX_SIZE]; // command argument buffer
41  };
42 
43 }
44 
45 #endif
Fw::FW_TYPEID_TLM_BUFF
@ FW_TYPEID_TLM_BUFF
Telemetry Buffer type id.
Definition: SerIds.hpp:47
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Fw::TlmBuffer
Definition: TlmBuffer.hpp:21
Fw::TlmBuffer::getBuffAddr
U8 * getBuffAddr()
gets buffer address for data filling
Definition: TlmBuffer.cpp:36
U8
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.hpp:73
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:28
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:79
FW_TLM_BUFFER_MAX_SIZE
#define FW_TLM_BUFFER_MAX_SIZE
Definition: FpConfig.hpp:248
Fw::TlmBuffer::operator=
TlmBuffer & operator=(const TlmBuffer &other)
Definition: TlmBuffer.cpp:22
Fw::TlmBuffer::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
Definition: TlmBuffer.hpp:25
Fw::TlmBuffer::~TlmBuffer
virtual ~TlmBuffer()
Definition: TlmBuffer.cpp:14
Fw::TlmBuffer::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Definition: TlmBuffer.hpp:26
Fw::TlmBuffer::getBuffCapacity
NATIVE_UINT_TYPE getBuffCapacity() const
returns capacity, not current size, of buffer
Definition: TlmBuffer.cpp:32
Fw::TlmBuffer::TlmBuffer
TlmBuffer()
Definition: TlmBuffer.cpp:11
Fw
Definition: SerIds.hpp:20