F´ Flight Software - C/C++ Documentation  NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PrmBuffer.hpp
Go to the documentation of this file.
1 /*
2  * Cmd.hpp
3  *
4  * Created on: Sep 10, 2012
5  * Author: ppandian
6  */
7 
8 /*
9  * Description:
10  * This object contains the ParamBuffer type, used for storing parameters
11  */
12 #ifndef FW_PRM_BUFFER_HPP
13 #define FW_PRM_BUFFER_HPP
14 
15 #include <FpConfig.hpp>
16 #include <Fw/Types/BasicTypes.hpp>
18 #include <Fw/Cfg/SerIds.hpp>
19 
20 namespace Fw {
21 
23  public:
24 
25  enum {
28  };
29 
30  ParamBuffer(const U8 *args, NATIVE_UINT_TYPE size);
31  ParamBuffer();
32  ParamBuffer(const ParamBuffer& other);
33  virtual ~ParamBuffer();
34  const ParamBuffer& operator=(const ParamBuffer& other);
35 
36  NATIVE_UINT_TYPE getBuffCapacity(void) const; // !< returns capacity, not current size, of buffer
37  U8* getBuffAddr(void);
38  const U8* getBuffAddr(void) const;
39 
40  private:
41  U8 m_data[FW_PARAM_BUFFER_MAX_SIZE]; // command argument buffer
42  };
43 
44 }
45 
46 #endif
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Serializable.hpp
U8
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.hpp:76
Fw::ParamBuffer::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
Definition: PrmBuffer.hpp:26
Fw::ParamBuffer::operator=
const ParamBuffer & operator=(const ParamBuffer &other)
Definition: PrmBuffer.cpp:22
Fw::ParamBuffer::getBuffAddr
U8 * getBuffAddr(void)
gets buffer address for data filling
Definition: PrmBuffer.cpp:36
Fw::ParamBuffer::getBuffCapacity
NATIVE_UINT_TYPE getBuffCapacity(void) const
returns capacity, not current size, of buffer
Definition: PrmBuffer.cpp:28
Fw::ParamBuffer::~ParamBuffer
virtual ~ParamBuffer()
Definition: PrmBuffer.cpp:14
Fw::ParamBuffer::ParamBuffer
ParamBuffer()
Definition: PrmBuffer.cpp:11
FW_PARAM_BUFFER_MAX_SIZE
#define FW_PARAM_BUFFER_MAX_SIZE
Definition: FpConfig.hpp:266
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:30
Fw::ParamBuffer
Definition: PrmBuffer.hpp:22
FpConfig.hpp
ISF configuration file.
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:79
Fw::ParamBuffer::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Definition: PrmBuffer.hpp:27
Fw
Definition: Buffer.cpp:21
Fw::FW_TYPEID_PRM_BUFF
@ FW_TYPEID_PRM_BUFF
Parameter Buffer type id.
Definition: SerIds.hpp:51