F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
VersionStatusEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title VersionStatusEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for VersionStatus enum
5 // ======================================================================
6 
7 #ifndef Svc_VersionStatusEnumAc_HPP
8 #define Svc_VersionStatusEnumAc_HPP
9 
10 #include "FpConfig.hpp"
12 #include "Fw/Types/String.hpp"
13 
14 namespace Svc {
15 
17  class VersionStatus :
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,
35  FAILURE = 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 = OK;
64  }
65 
68  const T e1
69  )
70  {
71  this->e = e1;
72  }
73 
76  const VersionStatus& obj
77  )
78  {
79  this->e = obj.e;
80  }
81 
82  public:
83 
84  // ----------------------------------------------------------------------
85  // Operators
86  // ----------------------------------------------------------------------
87 
90  const VersionStatus& 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 VersionStatus& 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
An enumeration for version status.
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
bool operator==(T e1) const
Equality operator.
@ SERIALIZED_SIZE
The size of the serial representation.
@ NUM_CONSTANTS
The number of enumerated constants.
T t
For backwards compatibility.
bool isValid() const
Check raw enum value for validity.
T e
The raw enum value.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
I32 SerialType
The serial representation type.
VersionStatus(const VersionStatus &obj)
Copy constructor.
bool operator!=(T e1) const
Inequality operator.
VersionStatus & operator=(const VersionStatus &obj)
Copy assignment operator (object)
VersionStatus(const T e1)
Constructor (user-provided value)
@ FAILURE
Failure to get version.
@ OK
Version was good.
VersionStatus()
Constructor (default value of OK)
SerializeStatus
forward declaration for string