F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
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 
14 namespace Fw {
15 
17  class SerialStatus :
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 e1
71  )
72  {
73  this->e = e1;
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 e1
98  );
99 
101  operator T() const
102  {
103  return this->e;
104  }
105 
107  bool operator==(T e1) const
108  {
109  return this->e == e1;
110  }
111 
113  bool operator!=(T e1) const
114  {
115  return !(*this == e1);
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 
139  Fw::SerializeBufferBase& buffer
140  ) const;
141 
144  Fw::SerializeBufferBase& buffer
145  );
146 
147 #if FW_SERIALIZABLE_TO_STRING
148 
150  void toString(
151  Fw::StringBase& sb
152  ) const;
153 
154 #endif
155 
156  public:
157 
158  // ----------------------------------------------------------------------
159  // Member variables
160  // ----------------------------------------------------------------------
161 
163  T e;
164 
165  };
166 
167 }
168 
169 #endif
Serialization operation succeeded.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
bool operator==(T e1) const
Equality operator.
SerialStatus()
Constructor (default value of OK)
The size of the serial representation.
Serialization status.
SerializeStatus
forward declaration for string
No room left in the buffer to serialize data.
T t
For backwards compatibility.
bool isValid() const
Check raw enum value for validity.
T
The raw enum type.
SerialStatus & operator=(const SerialStatus &obj)
Copy assignment operator (object)
C++-compatible configuration header for fprime configuration.
bool operator!=(T e1) const
Inequality operator.
Data was the wrong format (e.g. wrong packet type)
SerialStatus(const SerialStatus &obj)
Copy constructor.
SerialStatus(const T e1)
Constructor (user-provided value)
The number of enumerated constants.
forward declaration
I32 SerialType
The serial representation type.
T e
The raw enum value.
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.