F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
MutexStatusEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title MutexStatusEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for MutexStatus enum
5 // ======================================================================
6 
7 #ifndef Os_MutexStatusEnumAc_HPP
8 #define Os_MutexStatusEnumAc_HPP
9 
10 #include "FpConfig.hpp"
12 #include "Fw/Types/String.hpp"
13 
14 namespace Os {
15 
17  class MutexStatus :
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,
40  };
41 
43  typedef T t;
44 
45  public:
46 
47  // ----------------------------------------------------------------------
48  // Constants
49  // ----------------------------------------------------------------------
50 
51  enum {
56  };
57 
58  public:
59 
60  // ----------------------------------------------------------------------
61  // Constructors
62  // ----------------------------------------------------------------------
63 
66  {
67  this->e = OP_OK;
68  }
69 
72  const T e1
73  )
74  {
75  this->e = e1;
76  }
77 
80  const MutexStatus& obj
81  )
82  {
83  this->e = obj.e;
84  }
85 
86  public:
87 
88  // ----------------------------------------------------------------------
89  // Operators
90  // ----------------------------------------------------------------------
91 
94  const MutexStatus& obj
95  );
96 
99  T e1
100  );
101 
103  operator T() const
104  {
105  return this->e;
106  }
107 
109  bool operator==(T e1) const
110  {
111  return this->e == e1;
112  }
113 
115  bool operator!=(T e1) const
116  {
117  return !(*this == e1);
118  }
119 
120 #ifdef BUILD_UT
121 
123  friend std::ostream& operator<<(
124  std::ostream& os,
125  const MutexStatus& obj
126  );
127 
128 #endif
129 
130  public:
131 
132  // ----------------------------------------------------------------------
133  // Member functions
134  // ----------------------------------------------------------------------
135 
137  bool isValid() const;
138 
141  Fw::SerializeBufferBase& buffer
142  ) const;
143 
146  Fw::SerializeBufferBase& buffer
147  );
148 
149 #if FW_SERIALIZABLE_TO_STRING
150 
152  void toString(
153  Fw::StringBase& sb
154  ) const;
155 
156 #endif
157 
158  public:
159 
160  // ----------------------------------------------------------------------
161  // Member variables
162  // ----------------------------------------------------------------------
163 
165  T e;
166 
167  };
168 
169 }
170 
171 #endif
C++-compatible configuration header for fprime configuration.
forward declaration
FPP shadow-enum representing Os::Mutex::Status.
T e
The raw enum value.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
T
The raw enum type.
@ ERROR_OTHER
All other errors.
@ ERROR_DEADLOCK
Deadlock condition detected.
@ OP_OK
Operation was successful.
@ ERROR_BUSY
Mutex is busy.
MutexStatus(const MutexStatus &obj)
Copy constructor.
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
MutexStatus(const T e1)
Constructor (user-provided value)
bool isValid() const
Check raw enum value for validity.
@ NUM_CONSTANTS
The number of enumerated constants.
@ SERIALIZED_SIZE
The size of the serial representation.
T t
For backwards compatibility.
MutexStatus()
Constructor (default value of OP_OK)
I32 SerialType
The serial representation type.
bool operator!=(T e1) const
Inequality operator.
MutexStatus & operator=(const MutexStatus &obj)
Copy assignment operator (object)
bool operator==(T e1) const
Equality operator.
SerializeStatus
forward declaration for string