F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GenericStatusEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title GenericStatusEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for GenericStatus enum
5 // ======================================================================
6 
7 #ifndef Os_GenericStatusEnumAc_HPP
8 #define Os_GenericStatusEnumAc_HPP
9 
10 #include "FpConfig.hpp"
12 #include "Fw/Types/String.hpp"
13 
14 namespace Os {
15 
17  class GenericStatus :
18  public Fw::Serializable
19  {
20 
21  public:
22 
23  // ----------------------------------------------------------------------
24  // Types
25  // ----------------------------------------------------------------------
26 
28  typedef I32 SerialType;
29 
31  enum T {
33  OP_OK = 0,
35  ERROR = 1,
36  };
37 
39  typedef T t;
40 
41  public:
42 
43  // ----------------------------------------------------------------------
44  // Constants
45  // ----------------------------------------------------------------------
46 
47  enum {
52  };
53 
54  public:
55 
56  // ----------------------------------------------------------------------
57  // Constructors
58  // ----------------------------------------------------------------------
59 
62  {
63  this->e = OP_OK;
64  }
65 
68  const T e1
69  )
70  {
71  this->e = e1;
72  }
73 
76  const GenericStatus& obj
77  )
78  {
79  this->e = obj.e;
80  }
81 
82  public:
83 
84  // ----------------------------------------------------------------------
85  // Operators
86  // ----------------------------------------------------------------------
87 
90  const GenericStatus& obj
91  );
92 
95  T e1
96  );
97 
99  operator T() const
100  {
101  return this->e;
102  }
103 
105  bool operator==(T e1) const
106  {
107  return this->e == e1;
108  }
109 
111  bool operator!=(T e1) const
112  {
113  return !(*this == e1);
114  }
115 
116 #ifdef BUILD_UT
117 
119  friend std::ostream& operator<<(
120  std::ostream& os,
121  const GenericStatus& obj
122  );
123 
124 #endif
125 
126  public:
127 
128  // ----------------------------------------------------------------------
129  // Member functions
130  // ----------------------------------------------------------------------
131 
133  bool isValid() const;
134 
137  Fw::SerializeBufferBase& buffer
138  ) const;
139 
142  Fw::SerializeBufferBase& buffer
143  );
144 
145 #if FW_SERIALIZABLE_TO_STRING
146 
148  void toString(
149  Fw::StringBase& sb
150  ) const;
151 
152 #endif
153 
154  public:
155 
156  // ----------------------------------------------------------------------
157  // Member variables
158  // ----------------------------------------------------------------------
159 
161  T e;
162 
163  };
164 
165 }
166 
167 #endif
C++-compatible configuration header for fprime configuration.
forward declaration
FPP shadow-enum representing Os::Generic::Status.
T
The raw enum type.
@ ERROR
error return value
GenericStatus & operator=(const GenericStatus &obj)
Copy assignment operator (object)
T e
The raw enum value.
bool operator!=(T e1) const
Inequality operator.
bool operator==(T e1) const
Equality operator.
I32 SerialType
The serial representation type.
GenericStatus(const T e1)
Constructor (user-provided value)
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
@ SERIALIZED_SIZE
The size of the serial representation.
@ NUM_CONSTANTS
The number of enumerated constants.
bool isValid() const
Check raw enum value for validity.
T t
For backwards compatibility.
GenericStatus()
Constructor (default value of OP_OK)
GenericStatus(const GenericStatus &obj)
Copy constructor.
SerializeStatus
forward declaration for string