F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TimeBaseEnumAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title TimeBaseEnumAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for TimeBase enum
5 // ======================================================================
6 
7 #ifndef TimeBaseEnumAc_HPP
8 #define TimeBaseEnumAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
12 #include "Fw/Types/String.hpp"
13 
15 class TimeBase :
16  public Fw::Serializable
17 {
18 
19  public:
20 
21  // ----------------------------------------------------------------------
22  // Types
23  // ----------------------------------------------------------------------
24 
26  typedef U16 SerialType;
27 
29  enum T {
31  TB_NONE = 0,
39  TB_DONT_CARE = 65535,
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 = TB_NONE;
68  }
69 
72  const T e1
73  )
74  {
75  this->e = e1;
76  }
77 
80  const TimeBase& obj
81  )
82  {
83  this->e = obj.e;
84  }
85 
86  public:
87 
88  // ----------------------------------------------------------------------
89  // Operators
90  // ----------------------------------------------------------------------
91 
94  const TimeBase& 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 TimeBase& obj
126  );
127 
128 #endif
129 
130  public:
131 
132  // ----------------------------------------------------------------------
133  // Member functions
134  // ----------------------------------------------------------------------
135 
137  bool isValid() const;
138 
141  Fw::SerialBufferBase& buffer,
143  ) const;
144 
147  Fw::SerialBufferBase& buffer,
149  );
150 
151 #if FW_SERIALIZABLE_TO_STRING
152 
154  void toString(
155  Fw::StringBase& sb
156  ) const;
157 
158 #endif
159 
160  public:
161 
162  // ----------------------------------------------------------------------
163  // Member variables
164  // ----------------------------------------------------------------------
165 
167  T e;
168 
169 };
170 
171 #endif
The number of enumerated constants.
Don&#39;t care value for sequences. If FwTimeBaseStoreType is changed, value should be changed (Required)...
T t
For backwards compatibility.
TimeBase(const T e1)
Constructor (user-provided value)
TimeBase(const TimeBase &obj)
Copy constructor.
No time base has been established (Required)
T
The raw enum type.
bool isValid() const
Check raw enum value for validity.
T e
The raw enum value.
SerializeStatus
forward declaration for string
Time as reported on workstation where software is running. For testing. (Required) ...
TimeBase()
Constructor (default value of TB_NONE)
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialize raw enum value from SerialType.
TimeBase & operator=(const TimeBase &obj)
Copy assignment operator (object)
The size of the serial representation.
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialize raw enum value to SerialType.
bool operator==(T e1) const
Equality operator.
Indicates time is processor cycle time. Not tied to external time.
U16 SerialType
The serial representation type.
Endianness
Time as reported by the spacecraft clock.
Define enumeration for Time base types.
Big endian serialization.
bool operator!=(T e1) const
Inequality operator.