F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
SmSignalBuffer.hpp
Go to the documentation of this file.
1
/*
2
* SmSignalBuffer.hpp
3
*
4
*/
5
6
/*
7
* Description:
8
* This object contains the SmSignalBuffer type, used for attaching data to state machine signals
9
*/
10
#ifndef FW_SM_SIGNAL_BUFFER_HPP
11
#define FW_SM_SIGNAL_BUFFER_HPP
12
13
#include <
FpConfig.hpp
>
14
#include <
Fw/Types/Serializable.hpp
>
15
16
namespace
Fw
{
17
18
class
SmSignalBuffer
final :
public
SerializeBufferBase
{
19
public
:
20
21
enum
{
22
SERIALIZED_TYPE_ID
= 1010,
23
SERIALIZED_SIZE
=
FW_COM_BUFFER_MAX_SIZE
+
sizeof
(
FwSizeStoreType
)
// size of buffer + storage of size word
24
};
25
26
SmSignalBuffer
(
const
U8
*args,
Serializable::SizeType
size);
27
SmSignalBuffer
();
28
SmSignalBuffer
(
const
SmSignalBuffer
& other);
29
virtual
~SmSignalBuffer
();
30
SmSignalBuffer
&
operator=
(
const
SmSignalBuffer
& other);
31
32
Serializable::SizeType
getBuffCapacity
()
const
;
// !< returns capacity, not current size, of buffer
33
U8
*
getBuffAddr
();
34
const
U8
*
getBuffAddr
()
const
;
35
36
private
:
37
U8
m_bufferData[
FW_SM_SIGNAL_BUFFER_MAX_SIZE
];
// packet data buffer
38
};
39
40
}
41
42
#endif
Fw::SmSignalBuffer::~SmSignalBuffer
virtual ~SmSignalBuffer()
Definition:
SmSignalBuffer.cpp:16
Fw::SmSignalBuffer
Definition:
SmSignalBuffer.hpp:18
Fw::SmSignalBuffer::SmSignalBuffer
SmSignalBuffer()
Definition:
SmSignalBuffer.cpp:13
FwSizeStoreType
U16 FwSizeStoreType
Definition:
FpConfig.h:59
Fw::SerializeBufferBase
Definition:
Serializable.hpp:54
Fw::SmSignalBuffer::SERIALIZED_TYPE_ID
Definition:
SmSignalBuffer.hpp:22
FW_COM_BUFFER_MAX_SIZE
#define FW_COM_BUFFER_MAX_SIZE
Definition:
FpConfig.h:282
Fw::Serializable::SizeType
FwSizeType SizeType
Definition:
Serializable.hpp:28
FpConfig.hpp
C++-compatible configuration header for fprime configuration.
U8
uint8_t U8
8-bit unsigned integer
Definition:
BasicTypes.h:32
Fw::SmSignalBuffer::SERIALIZED_SIZE
Definition:
SmSignalBuffer.hpp:23
Fw::SmSignalBuffer::operator=
SmSignalBuffer & operator=(const SmSignalBuffer &other)
Definition:
SmSignalBuffer.cpp:29
FW_SM_SIGNAL_BUFFER_MAX_SIZE
#define FW_SM_SIGNAL_BUFFER_MAX_SIZE
Definition:
FpConfig.h:287
Fw::SmSignalBuffer::getBuffAddr
U8 * getBuffAddr()
gets buffer address for data filling
Definition:
SmSignalBuffer.cpp:50
Fw
Definition:
FppConstantsAc.hpp:121
Fw::SmSignalBuffer::getBuffCapacity
Serializable::SizeType getBuffCapacity() const
returns capacity, not current size, of buffer
Definition:
SmSignalBuffer.cpp:42
Serializable.hpp
Fw
Sm
SmSignalBuffer.hpp
Generated by
1.8.14