F´ Flight Software - C/C++ Documentation  NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CmdArgBuffer.hpp
Go to the documentation of this file.
1 /*
2  *
3  *
4  * Created on: March 1, 2014
5  * Author: T. Canham
6  */
7 
8 /*
9  * Description:
10  * This object contains the CmdARgBuffer type, used for holding the serialized arguments of commands
11  */
12 #ifndef FW_CMD_ARG_BUFFER_HPP
13 #define FW_CMD_ARG_BUFFER_HPP
14 
15 #include <Fw/Types/BasicTypes.hpp>
16 #include <Fw/Types/Serializable.hpp>
17 #include <FpConfig.hpp>
18 #include <Fw/Cfg/SerIds.hpp>
19 
20 namespace Fw {
21 
23  public:
24 
25  enum {
28  };
29 
30  CmdArgBuffer(const U8 *args, NATIVE_UINT_TYPE size);
31  CmdArgBuffer();
32  CmdArgBuffer(const CmdArgBuffer& other);
33  virtual ~CmdArgBuffer();
34  CmdArgBuffer& operator=(const CmdArgBuffer& other);
35 
37  U8* getBuffAddr();
38  const U8* getBuffAddr() const;
39 
40  private:
41  U8 m_bufferData[FW_CMD_ARG_BUFFER_MAX_SIZE];
42  };
43 
44 }
45 
46 #endif
Fw::CmdArgBuffer::SERIALIZED_SIZE
@ SERIALIZED_SIZE
size when serialized. Buffer + size of buffer
Definition: CmdArgBuffer.hpp:27
Fw::CmdArgBuffer::getBuffAddr
U8 * getBuffAddr()
return address of buffer (non const version)
Definition: CmdArgBuffer.cpp:36
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
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
Fw::CmdArgBuffer::CmdArgBuffer
CmdArgBuffer()
default constructor
Definition: CmdArgBuffer.cpp:11
Fw::CmdArgBuffer::~CmdArgBuffer
virtual ~CmdArgBuffer()
destructor
Definition: CmdArgBuffer.cpp:14
Fw::CmdArgBuffer::operator=
CmdArgBuffer & operator=(const CmdArgBuffer &other)
Equal operator.
Definition: CmdArgBuffer.cpp:22
Fw::CmdArgBuffer
Definition: CmdArgBuffer.hpp:22
Fw::CmdArgBuffer::getBuffCapacity
NATIVE_UINT_TYPE getBuffCapacity() const
return capacity of buffer (how much it can hold)
Definition: CmdArgBuffer.cpp:32
Fw::FW_TYPEID_CMD_BUFF
@ FW_TYPEID_CMD_BUFF
Command Buffer type id.
Definition: SerIds.hpp:45
Fw::CmdArgBuffer::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
type id for CmdArgBuffer
Definition: CmdArgBuffer.hpp:26
Fw
Definition: SerIds.hpp:20
FW_CMD_ARG_BUFFER_MAX_SIZE
#define FW_CMD_ARG_BUFFER_MAX_SIZE
Definition: FpConfig.hpp:218