F´ Flight Software - C/C++ Documentation
NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
Main Page
Related Pages
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
f
g
h
i
k
l
m
n
o
p
r
s
t
u
v
w
Functions
a
b
c
d
g
h
i
m
r
s
t
v
w
Variables
Typedefs
Enumerations
Enumerator
a
b
f
h
i
n
o
p
s
v
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
v
w
z
~
Functions
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
v
w
z
~
Variables
b
d
e
f
g
h
i
l
m
n
p
q
s
t
u
v
w
Typedefs
Enumerations
Enumerator
a
b
c
d
e
f
g
h
l
m
n
o
p
q
r
s
t
w
Related Functions
Files
File List
File Members
All
_
a
b
c
d
f
g
h
i
k
l
m
n
p
r
s
t
u
v
Functions
f
i
m
s
u
Variables
Typedefs
Enumerations
Enumerator
c
d
f
m
p
r
s
t
Macros
a
c
d
f
g
h
i
k
l
m
n
p
r
s
t
u
v
•
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
22
class
CmdArgBuffer
:
public
SerializeBufferBase
{
23
public
:
24
25
enum
{
26
SERIALIZED_TYPE_ID
=
FW_TYPEID_CMD_BUFF
,
27
SERIALIZED_SIZE
=
FW_CMD_ARG_BUFFER_MAX_SIZE
+
sizeof
(I32)
28
};
29
30
CmdArgBuffer
(
const
U8
*args,
NATIVE_UINT_TYPE
size);
31
CmdArgBuffer
();
32
CmdArgBuffer
(
const
CmdArgBuffer
& other);
33
virtual
~CmdArgBuffer
();
34
const
CmdArgBuffer
&
operator=
(
const
CmdArgBuffer
& other);
35
36
NATIVE_UINT_TYPE
getBuffCapacity
(
void
)
const
;
37
U8
*
getBuffAddr
(
void
);
38
const
U8
*
getBuffAddr
(
void
)
const
;
39
40
private
:
41
U8
m_data[
FW_CMD_ARG_BUFFER_MAX_SIZE
];
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::CmdArgBuffer::CmdArgBuffer
CmdArgBuffer()
default constructor
Definition:
CmdArgBuffer.cpp:11
Fw::CmdArgBuffer::getBuffAddr
U8 * getBuffAddr(void)
return address of buffer (non const version)
Definition:
CmdArgBuffer.cpp:36
Fw::CmdArgBuffer::operator=
const CmdArgBuffer & operator=(const CmdArgBuffer &other)
Equal operator.
Definition:
CmdArgBuffer.cpp:22
Fw::CmdArgBuffer::~CmdArgBuffer
virtual ~CmdArgBuffer()
destructor
Definition:
CmdArgBuffer.cpp:14
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition:
BasicTypes.hpp:30
Fw::CmdArgBuffer
Definition:
CmdArgBuffer.hpp:22
Fw::CmdArgBuffer::SERIALIZED_SIZE
@ SERIALIZED_SIZE
size when serialized. Buffer + size of buffer
Definition:
CmdArgBuffer.hpp:27
Fw::CmdArgBuffer::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
type id for CmdArgBuffer
Definition:
CmdArgBuffer.hpp:26
Fw::FW_TYPEID_CMD_BUFF
@ FW_TYPEID_CMD_BUFF
Command Buffer type id.
Definition:
SerIds.hpp:45
FpConfig.hpp
ISF configuration file.
FW_CMD_ARG_BUFFER_MAX_SIZE
#define FW_CMD_ARG_BUFFER_MAX_SIZE
Definition:
FpConfig.hpp:226
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
Fw::CmdArgBuffer::getBuffCapacity
NATIVE_UINT_TYPE getBuffCapacity(void) const
return capacity of buffer (how much it can hold)
Definition:
CmdArgBuffer.cpp:28
Fw
Definition:
Buffer.cpp:21
Fw
Cmd
CmdArgBuffer.hpp
Generated by
1.8.17