F´ Flight Software - C/C++ Documentation NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SerialStatusEnumAc.hpp
Go to the documentation of this file.
1// ======================================================================
2// \title SerialStatusEnumAc.hpp
3// \author Generated by fpp-to-cpp
4// \brief hpp file for SerialStatus enum
5// ======================================================================
6
7#ifndef Fw_SerialStatusEnumAc_HPP
8#define Fw_SerialStatusEnumAc_HPP
9
10#include "FpConfig.hpp"
12#include "Fw/Types/String.hpp"
13
14namespace Fw {
15
18 public Fw::Serializable
19 {
20
21 public:
22
23 // ----------------------------------------------------------------------
24 // Types
25 // ----------------------------------------------------------------------
26
28 typedef I32 SerialType;
29
31 enum T {
33 OK = 0,
38 };
39
41 typedef T t;
42
43 public:
44
45 // ----------------------------------------------------------------------
46 // Constants
47 // ----------------------------------------------------------------------
48
49 enum {
54 };
55
56 public:
57
58 // ----------------------------------------------------------------------
59 // Constructors
60 // ----------------------------------------------------------------------
61
64 {
65 this->e = OK;
66 }
67
70 const T e
71 )
72 {
73 this->e = e;
74 }
75
78 const SerialStatus& obj
79 )
80 {
81 this->e = obj.e;
82 }
83
84 public:
85
86 // ----------------------------------------------------------------------
87 // Operators
88 // ----------------------------------------------------------------------
89
92 const SerialStatus& obj
93 );
94
97 T e
98 );
99
101 operator T() const
102 {
103 return this->e;
104 }
105
107 bool operator==(T e) const
108 {
109 return this->e == e;
110 }
111
113 bool operator!=(T e) const
114 {
115 return !(*this == e);
116 }
117
118#ifdef BUILD_UT
119
121 friend std::ostream& operator<<(
122 std::ostream& os,
123 const SerialStatus& obj
124 );
125
126#endif
127
128 public:
129
130 // ----------------------------------------------------------------------
131 // Member functions
132 // ----------------------------------------------------------------------
133
135 bool isValid() const;
136
140 ) const;
141
145 );
146
147#if FW_SERIALIZABLE_TO_STRING || FW_ENABLE_TEXT_LOGGING || BUILD_UT
148
150 void toString(
151 Fw::StringBase& sb
152 ) const;
153
154#endif
155
156 public:
157
158 // ----------------------------------------------------------------------
159 // Member variables
160 // ----------------------------------------------------------------------
161
164
165 };
166
167}
168
169#endif
C++-compatible configuration header for fprime configuration.
Serialization status.
T
The raw enum type.
@ FORMAT_ERROR
Data was the wrong format (e.g. wrong packet type)
@ OK
Serialization operation succeeded.
@ NO_ROOM_LEFT
No room left in the buffer to serialize data.
SerialStatus()
Constructor (default value of OK)
SerialStatus(const T e)
Constructor (user-provided value)
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
I32 SerialType
The serial representation type.
SerialStatus(const SerialStatus &obj)
Copy constructor.
T e
The raw enum value.
bool operator!=(T e) const
Inequality operator.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
bool operator==(T e) const
Equality operator.
bool isValid() const
Check raw enum value for validity.
T t
For backwards compatibility.
SerialStatus & operator=(const SerialStatus &obj)
Copy assignment operator (object)
@ NUM_CONSTANTS
The number of enumerated constants.
@ SERIALIZED_SIZE
The size of the serial representation.
forward declaration
SerializeStatus
forward declaration for string