F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
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/FPrimeBasicTypes.hpp
>
16
#include <
Fw/Types/Serializable.hpp
>
17
#include <
Fw/Cfg/SerIds.hpp
>
18
19
namespace
Fw
{
20
21
class
CmdArgBuffer
final :
public
SerializeBufferBase
{
22
public
:
23
24
enum
{
25
SERIALIZED_TYPE_ID
=
FW_TYPEID_CMD_BUFF
,
26
SERIALIZED_SIZE
=
FW_CMD_ARG_BUFFER_MAX_SIZE
+
sizeof
(I32)
27
};
28
29
CmdArgBuffer
(
const
U8
*args,
FwSizeType
size);
30
CmdArgBuffer
();
31
CmdArgBuffer
(
const
CmdArgBuffer
& other);
32
virtual
~CmdArgBuffer
();
33
CmdArgBuffer
&
operator=
(
const
CmdArgBuffer
& other);
34
35
FwSizeType
getBuffCapacity
()
const
;
36
U8
*
getBuffAddr
();
37
const
U8
*
getBuffAddr
()
const
;
38
39
private
:
40
U8
m_bufferData[
FW_CMD_ARG_BUFFER_MAX_SIZE
];
41
};
42
43
}
44
45
#endif
Fw::CmdArgBuffer::getBuffCapacity
FwSizeType getBuffCapacity() const
return capacity of buffer (how much it can hold)
Definition:
CmdArgBuffer.cpp:32
FwSizeType
PlatformSizeType FwSizeType
Definition:
FwSizeTypeAliasAc.h:15
Fw::CmdArgBuffer::~CmdArgBuffer
virtual ~CmdArgBuffer()
destructor
Definition:
CmdArgBuffer.cpp:14
FPrimeBasicTypes.hpp
Fw::FW_TYPEID_CMD_BUFF
Command Buffer type id.
Definition:
SerIds.hpp:45
Fw::CmdArgBuffer::SERIALIZED_TYPE_ID
type id for CmdArgBuffer
Definition:
CmdArgBuffer.hpp:25
Fw::CmdArgBuffer::getBuffAddr
U8 * getBuffAddr()
return address of buffer (non const version)
Definition:
CmdArgBuffer.cpp:40
SerIds.hpp
Definitions for ISF type serial IDs.
Fw::SerializeBufferBase
Definition:
Serializable.hpp:54
U8
uint8_t U8
8-bit unsigned integer
Definition:
BasicTypes.h:56
Fw::CmdArgBuffer::CmdArgBuffer
CmdArgBuffer()
default constructor
Definition:
CmdArgBuffer.cpp:11
FW_CMD_ARG_BUFFER_MAX_SIZE
#define FW_CMD_ARG_BUFFER_MAX_SIZE
Definition:
FpConfig.h:198
Fw::CmdArgBuffer
Definition:
CmdArgBuffer.hpp:21
Fw::CmdArgBuffer::operator=
CmdArgBuffer & operator=(const CmdArgBuffer &other)
Equal operator.
Definition:
CmdArgBuffer.cpp:22
Fw::CmdArgBuffer::SERIALIZED_SIZE
size when serialized. Buffer + size of buffer
Definition:
CmdArgBuffer.hpp:26
Fw
Definition:
FppConstantsAc.hpp:121
Serializable.hpp
Fw
Cmd
CmdArgBuffer.hpp
Generated by
1.8.14