F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
HeaderSerializableAc.hpp
Go to the documentation of this file.
1
// ======================================================================
2
// \title HeaderSerializableAc.hpp
3
// \author Generated by fpp-to-cpp
4
// \brief hpp file for Header struct
5
// ======================================================================
6
7
#ifndef Svc_Fpy_HeaderSerializableAc_HPP
8
#define Svc_Fpy_HeaderSerializableAc_HPP
9
10
#include "
Fw/FPrimeBasicTypes.hpp
"
11
#include "
Fw/Types/ExternalString.hpp
"
12
#include "
Fw/Types/Serializable.hpp
"
13
#include "
Fw/Types/String.hpp
"
14
15
namespace
Svc
{
16
17
namespace
Fpy {
18
19
class
Header
:
20
public
Fw::Serializable
21
{
22
23
public
:
24
25
// ----------------------------------------------------------------------
26
// Constants
27
// ----------------------------------------------------------------------
28
29
enum
{
31
SERIALIZED_SIZE
=
32
sizeof
(
U8
) +
33
sizeof
(
U8
) +
34
sizeof
(
U8
) +
35
sizeof
(
U8
) +
36
sizeof
(
U8
) +
37
sizeof
(U16) +
38
sizeof
(U32)
39
};
40
41
public
:
42
43
// ----------------------------------------------------------------------
44
// Constructors
45
// ----------------------------------------------------------------------
46
48
Header
();
49
51
Header
(
52
U8
majorVersion,
53
U8
minorVersion,
54
U8
patchVersion,
55
U8
schemaVersion,
56
U8
argumentCount,
57
U16 statementCount,
58
U32 bodySize
59
);
60
62
Header
(
63
const
Header
& obj
64
);
65
66
public
:
67
68
// ----------------------------------------------------------------------
69
// Operators
70
// ----------------------------------------------------------------------
71
73
Header
&
operator=
(
74
const
Header
& obj
75
);
76
78
bool
operator==
(
79
const
Header
& obj
80
)
const
;
81
83
bool
operator!=
(
84
const
Header
& obj
85
)
const
;
86
87
#ifdef BUILD_UT
88
90
friend
std::ostream& operator<<(
91
std::ostream& os,
92
const
Header
& obj
93
);
94
95
#endif
96
97
public
:
98
99
// ----------------------------------------------------------------------
100
// Member functions
101
// ----------------------------------------------------------------------
102
104
Fw::SerializeStatus
serializeTo
(
105
Fw::SerializeBufferBase
& buffer
106
)
const
;
107
109
Fw::SerializeStatus
deserializeFrom
(
110
Fw::SerializeBufferBase
& buffer
111
);
112
114
FwSizeType
serializedSize
()
const
;
115
116
#if FW_SERIALIZABLE_TO_STRING
117
119
void
toString(
120
Fw::StringBase
& sb
121
)
const
;
122
123
#endif
124
125
// ----------------------------------------------------------------------
126
// Getter functions
127
// ----------------------------------------------------------------------
128
130
U8
get_majorVersion
()
const
131
{
132
return
this->
m_majorVersion
;
133
}
134
136
U8
get_minorVersion
()
const
137
{
138
return
this->
m_minorVersion
;
139
}
140
142
U8
get_patchVersion
()
const
143
{
144
return
this->
m_patchVersion
;
145
}
146
148
U8
get_schemaVersion
()
const
149
{
150
return
this->
m_schemaVersion
;
151
}
152
154
U8
get_argumentCount
()
const
155
{
156
return
this->
m_argumentCount
;
157
}
158
160
U16
get_statementCount
()
const
161
{
162
return
this->
m_statementCount
;
163
}
164
166
U32
get_bodySize
()
const
167
{
168
return
this->
m_bodySize
;
169
}
170
171
// ----------------------------------------------------------------------
172
// Setter functions
173
// ----------------------------------------------------------------------
174
176
void
set
(
177
U8
majorVersion,
178
U8
minorVersion,
179
U8
patchVersion,
180
U8
schemaVersion,
181
U8
argumentCount,
182
U16 statementCount,
183
U32 bodySize
184
);
185
187
void
set_majorVersion
(
U8
majorVersion);
188
190
void
set_minorVersion
(
U8
minorVersion);
191
193
void
set_patchVersion
(
U8
patchVersion);
194
196
void
set_schemaVersion
(
U8
schemaVersion);
197
199
void
set_argumentCount
(
U8
argumentCount);
200
202
void
set_statementCount
(U16 statementCount);
203
205
void
set_bodySize
(U32 bodySize);
206
207
protected
:
208
209
// ----------------------------------------------------------------------
210
// Member variables
211
// ----------------------------------------------------------------------
212
213
U8
m_majorVersion
;
214
U8
m_minorVersion
;
215
U8
m_patchVersion
;
216
U8
m_schemaVersion
;
217
U8
m_argumentCount
;
218
U16
m_statementCount
;
219
U32
m_bodySize
;
220
221
};
222
223
}
224
225
}
226
227
#endif
Svc::Fpy::Header::set_statementCount
void set_statementCount(U16 statementCount)
Set member statementCount.
Definition:
HeaderSerializableAc.cpp:315
Svc::Fpy::Header::set_bodySize
void set_bodySize(U32 bodySize)
Set member bodySize.
Definition:
HeaderSerializableAc.cpp:321
Svc::Fpy::Header::set_patchVersion
void set_patchVersion(U8 patchVersion)
Set member patchVersion.
Definition:
HeaderSerializableAc.cpp:297
Svc::Fpy::Header::get_statementCount
U16 get_statementCount() const
Get member statementCount.
Definition:
HeaderSerializableAc.hpp:160
String.hpp
Svc::Fpy::Header::operator!=
bool operator!=(const Header &obj) const
Inequality operator.
Definition:
HeaderSerializableAc.cpp:99
FwSizeType
PlatformSizeType FwSizeType
Definition:
FwSizeTypeAliasAc.h:15
ExternalString.hpp
FPrimeBasicTypes.hpp
Svc::Fpy::Header::serializedSize
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
Definition:
HeaderSerializableAc.cpp:194
Svc::Fpy::Header::get_patchVersion
U8 get_patchVersion() const
Get member patchVersion.
Definition:
HeaderSerializableAc.hpp:142
Svc::Fpy::Header::set_argumentCount
void set_argumentCount(U8 argumentCount)
Set member argumentCount.
Definition:
HeaderSerializableAc.cpp:309
Svc::Fpy::Header::set_schemaVersion
void set_schemaVersion(U8 schemaVersion)
Set member schemaVersion.
Definition:
HeaderSerializableAc.cpp:303
Svc::Fpy::Header::m_minorVersion
U8 m_minorVersion
Definition:
HeaderSerializableAc.hpp:214
Svc::Fpy::Header
Definition:
HeaderSerializableAc.hpp:19
Svc::Fpy::Header::m_statementCount
U16 m_statementCount
Definition:
HeaderSerializableAc.hpp:218
Svc::Fpy::Header::set_minorVersion
void set_minorVersion(U8 minorVersion)
Set member minorVersion.
Definition:
HeaderSerializableAc.cpp:291
Fw::SerializeStatus
SerializeStatus
forward declaration for string
Definition:
Serializable.hpp:14
Svc::Fpy::Header::SERIALIZED_SIZE
The size of the serial representation.
Definition:
HeaderSerializableAc.hpp:31
Svc::Fpy::Header::get_majorVersion
U8 get_majorVersion() const
Get member majorVersion.
Definition:
HeaderSerializableAc.hpp:130
Svc::Fpy::Header::get_schemaVersion
U8 get_schemaVersion() const
Get member schemaVersion.
Definition:
HeaderSerializableAc.hpp:148
Fw::SerializeBufferBase
Definition:
Serializable.hpp:64
Svc::Fpy::Header::get_minorVersion
U8 get_minorVersion() const
Get member minorVersion.
Definition:
HeaderSerializableAc.hpp:136
Svc::Fpy::Header::get_bodySize
U32 get_bodySize() const
Get member bodySize.
Definition:
HeaderSerializableAc.hpp:166
Svc::Fpy::Header::m_bodySize
U32 m_bodySize
Definition:
HeaderSerializableAc.hpp:219
U8
uint8_t U8
8-bit unsigned integer
Definition:
BasicTypes.h:53
Svc::Fpy::Header::operator==
bool operator==(const Header &obj) const
Equality operator.
Definition:
HeaderSerializableAc.cpp:84
Svc::Fpy::Header::deserializeFrom
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase &buffer)
Deserialization.
Definition:
HeaderSerializableAc.cpp:157
Svc::Fpy::Header::m_argumentCount
U8 m_argumentCount
Definition:
HeaderSerializableAc.hpp:217
Svc::Fpy::Header::m_schemaVersion
U8 m_schemaVersion
Definition:
HeaderSerializableAc.hpp:216
Svc::Fpy::Header::serializeTo
Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase &buffer) const
Serialization.
Definition:
HeaderSerializableAc.cpp:120
Svc::Fpy::Header::Header
Header()
Constructor (default value)
Definition:
HeaderSerializableAc.cpp:19
Svc::Fpy::Header::get_argumentCount
U8 get_argumentCount() const
Get member argumentCount.
Definition:
HeaderSerializableAc.hpp:154
Fw::Serializable
forward declaration
Definition:
Serializable.hpp:25
Svc
RateGroupDivider component implementation.
Definition:
ActiveRateGroupCfg.hpp:18
Svc::Fpy::Header::m_patchVersion
U8 m_patchVersion
Definition:
HeaderSerializableAc.hpp:215
Svc::Fpy::Header::operator=
Header & operator=(const Header &obj)
Copy assignment operator.
Definition:
HeaderSerializableAc.cpp:73
Fw::StringBase
Definition:
StringBase.hpp:25
Svc::Fpy::Header::set_majorVersion
void set_majorVersion(U8 majorVersion)
Set member majorVersion.
Definition:
HeaderSerializableAc.cpp:285
Svc::Fpy::Header::m_majorVersion
U8 m_majorVersion
Definition:
HeaderSerializableAc.hpp:213
Serializable.hpp
Svc
FpySequencer
HeaderSerializableAc.hpp
Generated by
1.8.14