F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TimeValueSerializableAc.hpp
Go to the documentation of this file.
1
// ======================================================================
2
// \title TimeValueSerializableAc.hpp
3
// \author Generated by fpp-to-cpp
4
// \brief hpp file for TimeValue struct
5
// ======================================================================
6
7
#ifndef Fw_TimeValueSerializableAc_HPP
8
#define Fw_TimeValueSerializableAc_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
#include "
default/config/FwTimeContextStoreTypeAliasAc.hpp
"
15
#include "
default/config/TimeBaseEnumAc.hpp
"
16
17
namespace
Fw
{
18
20
class
TimeValue
:
21
public
Fw::Serializable
22
{
23
24
public
:
25
26
// ----------------------------------------------------------------------
27
// Constants
28
// ----------------------------------------------------------------------
29
30
enum
{
32
SERIALIZED_SIZE
=
33
TimeBase::SERIALIZED_SIZE
+
34
sizeof
(
FwTimeContextStoreType
) +
35
sizeof
(U32) +
36
sizeof
(U32)
37
};
38
39
public
:
40
41
// ----------------------------------------------------------------------
42
// Constructors
43
// ----------------------------------------------------------------------
44
46
TimeValue
();
47
49
TimeValue
(
50
TimeBase::T
timeBase,
51
FwTimeContextStoreType
timeContext,
52
U32 seconds,
53
U32 useconds
54
);
55
57
TimeValue
(
58
const
TimeValue
& obj
59
);
60
61
public
:
62
63
// ----------------------------------------------------------------------
64
// Operators
65
// ----------------------------------------------------------------------
66
68
TimeValue
&
operator=
(
69
const
TimeValue
& obj
70
);
71
73
bool
operator==
(
74
const
TimeValue
& obj
75
)
const
;
76
78
bool
operator!=
(
79
const
TimeValue
& obj
80
)
const
;
81
82
#ifdef BUILD_UT
83
85
friend
std::ostream& operator<<(
86
std::ostream& os,
87
const
TimeValue
& obj
88
);
89
90
#endif
91
92
public
:
93
94
// ----------------------------------------------------------------------
95
// Member functions
96
// ----------------------------------------------------------------------
97
99
Fw::SerializeStatus
serializeTo
(
100
Fw::SerializeBufferBase
& buffer
101
)
const
;
102
104
Fw::SerializeStatus
deserializeFrom
(
105
Fw::SerializeBufferBase
& buffer
106
);
107
109
FwSizeType
serializedSize
()
const
;
110
111
#if FW_SERIALIZABLE_TO_STRING
112
114
void
toString(
115
Fw::StringBase
& sb
116
)
const
;
117
118
#endif
119
120
// ----------------------------------------------------------------------
121
// Getter functions
122
// ----------------------------------------------------------------------
123
125
TimeBase::T
get_timeBase
()
const
126
{
127
return
this->
m_timeBase
.
e
;
128
}
129
131
FwTimeContextStoreType
get_timeContext
()
const
132
{
133
return
this->
m_timeContext
;
134
}
135
137
U32
get_seconds
()
const
138
{
139
return
this->
m_seconds
;
140
}
141
143
U32
get_useconds
()
const
144
{
145
return
this->
m_useconds
;
146
}
147
148
// ----------------------------------------------------------------------
149
// Setter functions
150
// ----------------------------------------------------------------------
151
153
void
set
(
154
TimeBase::T
timeBase,
155
FwTimeContextStoreType
timeContext,
156
U32 seconds,
157
U32 useconds
158
);
159
161
void
set_timeBase
(
TimeBase::T
timeBase);
162
164
void
set_timeContext
(
FwTimeContextStoreType
timeContext);
165
167
void
set_seconds
(U32 seconds);
168
170
void
set_useconds
(U32 useconds);
171
172
protected
:
173
174
// ----------------------------------------------------------------------
175
// Member variables
176
// ----------------------------------------------------------------------
177
178
TimeBase
m_timeBase
;
179
FwTimeContextStoreType
m_timeContext
;
180
U32
m_seconds
;
181
U32
m_useconds
;
182
183
};
184
185
}
186
187
#endif
Fw::TimeValue::serializedSize
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
Definition:
TimeValueSerializableAc.cpp:153
Fw::TimeValue::get_useconds
U32 get_useconds() const
Get member useconds.
Definition:
TimeValueSerializableAc.hpp:143
Fw::TimeValue::get_timeContext
FwTimeContextStoreType get_timeContext() const
Get member timeContext.
Definition:
TimeValueSerializableAc.hpp:131
Fw::TimeValue::m_useconds
U32 m_useconds
Definition:
TimeValueSerializableAc.hpp:181
String.hpp
FwSizeType
PlatformSizeType FwSizeType
Definition:
FwSizeTypeAliasAc.h:15
Fw::TimeValue::operator==
bool operator==(const TimeValue &obj) const
Equality operator.
Definition:
TimeValueSerializableAc.cpp:70
ExternalString.hpp
FPrimeBasicTypes.hpp
FwTimeContextStoreTypeAliasAc.hpp
TimeBaseEnumAc.hpp
Fw::TimeValue::m_timeBase
TimeBase m_timeBase
Definition:
TimeValueSerializableAc.hpp:178
Fw::TimeValue::get_timeBase
TimeBase::T get_timeBase() const
Get member timeBase.
Definition:
TimeValueSerializableAc.hpp:125
FwTimeContextStoreType
U8 FwTimeContextStoreType
The type used to serialize a time context value.
Definition:
FwTimeContextStoreTypeAliasAc.h:13
TimeBase::T
T
The raw enum type.
Definition:
TimeBaseEnumAc.hpp:29
TimeBase::e
T e
The raw enum value.
Definition:
TimeBaseEnumAc.hpp:163
Fw::SerializeStatus
SerializeStatus
forward declaration for string
Definition:
Serializable.hpp:14
Fw::TimeValue::set_seconds
void set_seconds(U32 seconds)
Set member seconds.
Definition:
TimeValueSerializableAc.cpp:229
Fw::TimeValue::deserializeFrom
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase &buffer)
Deserialization.
Definition:
TimeValueSerializableAc.cpp:128
Fw::TimeValue::serializeTo
Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase &buffer) const
Serialization.
Definition:
TimeValueSerializableAc.cpp:103
Fw::SerializeBufferBase
Definition:
Serializable.hpp:70
Fw::TimeValue::operator=
TimeValue & operator=(const TimeValue &obj)
Copy assignment operator.
Definition:
TimeValueSerializableAc.cpp:59
Fw::TimeValue::SERIALIZED_SIZE
The size of the serial representation.
Definition:
TimeValueSerializableAc.hpp:32
Fw::TimeValue::TimeValue
TimeValue()
Constructor (default value)
Definition:
TimeValueSerializableAc.cpp:17
Fw::TimeValue::m_timeContext
FwTimeContextStoreType m_timeContext
Definition:
TimeValueSerializableAc.hpp:179
Fw::TimeValue::operator!=
bool operator!=(const TimeValue &obj) const
Inequality operator.
Definition:
TimeValueSerializableAc.cpp:82
Fw::TimeValue::m_seconds
U32 m_seconds
Definition:
TimeValueSerializableAc.hpp:180
Fw::TimeValue
Data structure for Time.
Definition:
TimeValueSerializableAc.hpp:20
Fw::TimeValue::set_timeBase
void set_timeBase(TimeBase::T timeBase)
Set member timeBase.
Definition:
TimeValueSerializableAc.cpp:217
Fw::TimeValue::set_timeContext
void set_timeContext(FwTimeContextStoreType timeContext)
Set member timeContext.
Definition:
TimeValueSerializableAc.cpp:223
Fw::Serializable
forward declaration
Definition:
Serializable.hpp:25
Fw::TimeValue::get_seconds
U32 get_seconds() const
Get member seconds.
Definition:
TimeValueSerializableAc.hpp:137
Fw
Definition:
FppConstantsAc.hpp:121
TimeBase
Define enumeration for Time base types.
Definition:
TimeBaseEnumAc.hpp:15
Fw::StringBase
Definition:
StringBase.hpp:25
TimeBase::SERIALIZED_SIZE
The size of the serial representation.
Definition:
TimeBaseEnumAc.hpp:51
Fw::TimeValue::set_useconds
void set_useconds(U32 useconds)
Set member useconds.
Definition:
TimeValueSerializableAc.cpp:235
Serializable.hpp
Fw
Time
TimeValueSerializableAc.hpp
Generated by
1.8.14