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
DeserialStatusEnumAc.hpp
Go to the documentation of this file.
1// ======================================================================
2// \title DeserialStatusEnumAc.hpp
3// \author Generated by fpp-to-cpp
4// \brief hpp file for DeserialStatus enum
5// ======================================================================
6
7#ifndef Fw_DeserialStatusEnumAc_HPP
8#define Fw_DeserialStatusEnumAc_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
42
44 typedef T t;
45
46 public:
47
48 // ----------------------------------------------------------------------
49 // Constants
50 // ----------------------------------------------------------------------
51
52 enum {
57 };
58
59 public:
60
61 // ----------------------------------------------------------------------
62 // Constructors
63 // ----------------------------------------------------------------------
64
67 {
68 this->e = OK;
69 }
70
73 const T e
74 )
75 {
76 this->e = e;
77 }
78
81 const DeserialStatus& obj
82 )
83 {
84 this->e = obj.e;
85 }
86
87 public:
88
89 // ----------------------------------------------------------------------
90 // Operators
91 // ----------------------------------------------------------------------
92
95 const DeserialStatus& obj
96 );
97
100 T e
101 );
102
104 operator T() const
105 {
106 return this->e;
107 }
108
110 bool operator==(T e) const
111 {
112 return this->e == e;
113 }
114
116 bool operator!=(T e) const
117 {
118 return !(*this == e);
119 }
120
121#ifdef BUILD_UT
122
124 friend std::ostream& operator<<(
125 std::ostream& os,
126 const DeserialStatus& obj
127 );
128
129#endif
130
131 public:
132
133 // ----------------------------------------------------------------------
134 // Member functions
135 // ----------------------------------------------------------------------
136
138 bool isValid() const;
139
143 ) const;
144
148 );
149
150#if FW_SERIALIZABLE_TO_STRING || FW_ENABLE_TEXT_LOGGING || BUILD_UT
151
153 void toString(
154 Fw::StringBase& sb
155 ) const;
156
157#endif
158
159 public:
160
161 // ----------------------------------------------------------------------
162 // Member variables
163 // ----------------------------------------------------------------------
164
167
168 };
169
170}
171
172#endif
C++-compatible configuration header for fprime configuration.
Deserialization status.
T e
The raw enum value.
bool isValid() const
Check raw enum value for validity.
@ SERIALIZED_SIZE
The size of the serial representation.
@ NUM_CONSTANTS
The number of enumerated constants.
DeserialStatus & operator=(const DeserialStatus &obj)
Copy assignment operator (object)
T t
For backwards compatibility.
DeserialStatus(const DeserialStatus &obj)
Copy constructor.
DeserialStatus()
Constructor (default value of OK)
DeserialStatus(const T e)
Constructor (user-provided value)
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
@ TYPE_MISMATCH
Deserialized type ID didn't match.
@ FORMAT_ERROR
Deserialization data had incorrect values (unexpected data types)
@ SIZE_MISMATCH
Data was left in in the buffer, but not enough to deserialize.
@ BUFFER_EMPTY
Deserialization buffer was empty when trying to read data.
I32 SerialType
The serial representation type.
bool operator==(T e) const
Equality operator.
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
bool operator!=(T e) const
Inequality operator.
forward declaration
SerializeStatus
forward declaration for string