F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HealthEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title HealthEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for Health enum
5 // ======================================================================
6 
7 #ifndef Fw_HealthEnumAc_HPP
8 #define Fw_HealthEnumAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
12 #include "Fw/Types/String.hpp"
13 
14 namespace Fw {
15 
17  class Health :
18  public Fw::Serializable
19  {
20 
21  public:
22 
23  // ----------------------------------------------------------------------
24  // Types
25  // ----------------------------------------------------------------------
26 
28  typedef U8 SerialType;
29 
31  enum T {
33  HEALTHY = 0,
35  SICK = 1,
37  FAILED = 2,
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 = HEALTHY;
66  }
67 
70  const T e1
71  )
72  {
73  this->e = e1;
74  }
75 
78  const Health& obj
79  )
80  {
81  this->e = obj.e;
82  }
83 
84  public:
85 
86  // ----------------------------------------------------------------------
87  // Operators
88  // ----------------------------------------------------------------------
89 
92  const Health& 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 Health& 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
Health & operator=(const Health &obj)
Copy assignment operator (object)
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
Health states.
The number of enumerated constants.
Failed state.
Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
SerializeStatus
forward declaration for string
bool operator==(T e1) const
Equality operator.
Health()
Constructor (default value of HEALTHY)
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:53
Health(const T e1)
Constructor (user-provided value)
Health(const Health &obj)
Copy constructor.
bool isValid() const
Check raw enum value for validity.
Healthy state.
forward declaration
Sick state.
T t
For backwards compatibility.
T
The raw enum type.
T e
The raw enum value.
The size of the serial representation.
U8 SerialType
The serial representation type.
bool operator!=(T e1) const
Inequality operator.