F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
OnEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title OnEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for On enum
5 // ======================================================================
6 
7 #ifndef Fw_OnEnumAc_HPP
8 #define Fw_OnEnumAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
12 #include "Fw/Types/String.hpp"
13 
14 namespace Fw {
15 
17  class On :
18  public Fw::Serializable
19  {
20 
21  public:
22 
23  // ----------------------------------------------------------------------
24  // Types
25  // ----------------------------------------------------------------------
26 
28  typedef U8 SerialType;
29 
31  enum T {
33  OFF = 0,
35  ON = 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 
61  On()
62  {
63  this->e = OFF;
64  }
65 
67  On(
68  const T e1
69  )
70  {
71  this->e = e1;
72  }
73 
75  On(
76  const On& obj
77  )
78  {
79  this->e = obj.e;
80  }
81 
82  public:
83 
84  // ----------------------------------------------------------------------
85  // Operators
86  // ----------------------------------------------------------------------
87 
89  On& operator=(
90  const On& obj
91  );
92 
94  On& operator=(
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 On& obj
122  );
123 
124 #endif
125 
126  public:
127 
128  // ----------------------------------------------------------------------
129  // Member functions
130  // ----------------------------------------------------------------------
131 
133  bool isValid() const;
134 
137  Fw::SerializeBufferBase& buffer,
139  ) const;
140 
143  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
The number of enumerated constants.
Definition: OnEnumAc.hpp:51
Off state.
Definition: OnEnumAc.hpp:33
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialize raw enum value from SerialType.
Definition: OnEnumAc.cpp:68
On and off states.
Definition: OnEnumAc.hpp:17
bool isValid() const
Check raw enum value for validity.
Definition: OnEnumAc.cpp:49
Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialize raw enum value to SerialType.
Definition: OnEnumAc.cpp:55
On & operator=(const On &obj)
Copy assignment operator (object)
Definition: OnEnumAc.cpp:20
T e
The raw enum value.
Definition: OnEnumAc.hpp:163
SerializeStatus
forward declaration for string
bool operator!=(T e1) const
Inequality operator.
Definition: OnEnumAc.hpp:111
On state.
Definition: OnEnumAc.hpp:35
U8 SerialType
The serial representation type.
Definition: OnEnumAc.hpp:28
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:53
On(const T e1)
Constructor (user-provided value)
Definition: OnEnumAc.hpp:67
T
The raw enum type.
Definition: OnEnumAc.hpp:31
The size of the serial representation.
Definition: OnEnumAc.hpp:49
On()
Constructor (default value of OFF)
Definition: OnEnumAc.hpp:61
On(const On &obj)
Copy constructor.
Definition: OnEnumAc.hpp:75
T t
For backwards compatibility.
Definition: OnEnumAc.hpp:39
Implementation of malloc based allocator.
Endianness
Big endian serialization.
bool operator==(T e1) const
Equality operator.
Definition: OnEnumAc.hpp:105