F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
ApidEnumAc.cpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title ApidEnumAc.cpp
3 // \author Generated by fpp-to-cpp
4 // \brief cpp file for Apid enum
5 // ======================================================================
6 
7 #include <cstring>
8 #include <limits>
9 
10 #include "Fw/Types/Assert.hpp"
12 
13 namespace ComCfg {
14 
15  // ----------------------------------------------------------------------
16  // Operators
17  // ----------------------------------------------------------------------
18 
19  Apid& Apid ::
20  operator=(const Apid& obj)
21  {
22  this->e = obj.e;
23  return *this;
24  }
25 
26  Apid& Apid ::
28  {
29  this->e = e1;
30  return *this;
31  }
32 
33 #ifdef BUILD_UT
34 
35  std::ostream& operator<<(std::ostream& os, const Apid& obj) {
36  Fw::String s;
37  obj.toString(s);
38  os << s;
39  return os;
40  }
41 
42 #endif
43 
44  // ----------------------------------------------------------------------
45  // Member functions
46  // ----------------------------------------------------------------------
47 
48  bool Apid ::
49  isValid() const
50  {
51  return ((e >= FW_PACKET_COMMAND) && (e <= FW_PACKET_IDLE))
52  || ((e >= FW_PACKET_HAND) && (e <= FW_PACKET_UNKNOWN))
53  || ((e >= SPP_IDLE_PACKET) && (e <= INVALID_UNINITIALIZED));
54  }
55 
58  Fw::SerialBufferBase& buffer,
59  Fw::Endianness mode
60  ) const
61  {
62  const Fw::SerializeStatus status = buffer.serializeFrom(
63  static_cast<SerialType>(this->e),
64  mode
65  );
66  return status;
67  }
68 
71  Fw::SerialBufferBase& buffer,
72  Fw::Endianness mode
73  )
74  {
75  SerialType es;
76  Fw::SerializeStatus status = buffer.deserializeTo(es, mode);
77  if (status == Fw::FW_SERIALIZE_OK) {
78  this->e = static_cast<T>(es);
79  if (!this->isValid()) {
81  }
82  }
83  return status;
84  }
85 
86 #if FW_SERIALIZABLE_TO_STRING
87 
88  void Apid ::
89  toString(Fw::StringBase& sb) const
90  {
91  Fw::String s;
92  switch (e) {
93  case FW_PACKET_COMMAND:
94  s = "FW_PACKET_COMMAND";
95  break;
96  case FW_PACKET_TELEM:
97  s = "FW_PACKET_TELEM";
98  break;
99  case FW_PACKET_LOG:
100  s = "FW_PACKET_LOG";
101  break;
102  case FW_PACKET_FILE:
103  s = "FW_PACKET_FILE";
104  break;
106  s = "FW_PACKET_PACKETIZED_TLM";
107  break;
108  case FW_PACKET_DP:
109  s = "FW_PACKET_DP";
110  break;
111  case FW_PACKET_IDLE:
112  s = "FW_PACKET_IDLE";
113  break;
114  case FW_PACKET_HAND:
115  s = "FW_PACKET_HAND";
116  break;
117  case FW_PACKET_UNKNOWN:
118  s = "FW_PACKET_UNKNOWN";
119  break;
120  case SPP_IDLE_PACKET:
121  s = "SPP_IDLE_PACKET";
122  break;
124  s = "INVALID_UNINITIALIZED";
125  break;
126  default:
127  s = "[invalid]";
128  break;
129  }
130  sb.format("%s (%" PRIu16 ")", s.toChar(), e);
131  }
132 
133 #elif FW_ENABLE_TEXT_LOGGING
134 
135  void Apid ::
136  toString(Fw::StringBase& sb) const
137  {
138  sb.format("%" PRIu16 "", e);
139  }
140 
141 #endif
142 
143 }
Serialization/Deserialization operation was successful.
Packetized telemetry packet type.
Definition: ApidEnumAc.hpp:41
const char * toChar() const
Convert to a C-style char*.
Definition: String.hpp:50
Deserialization data had incorrect values (unexpected data types)
virtual SerializeStatus serializeFrom(U8 val, Endianness mode=Endianness::BIG)=0
Serialize an 8-bit unsigned integer value.
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialize raw enum value from SerialType.
Definition: ApidEnumAc.cpp:70
SerializeStatus
forward declaration for string
virtual SerializeStatus deserializeTo(U8 &val, Endianness mode=Endianness::BIG)=0
Deserialize an 8-bit unsigned integer value.
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialize raw enum value to SerialType.
Definition: ApidEnumAc.cpp:57
F Prime handshake.
Definition: ApidEnumAc.hpp:47
T
The raw enum type.
Definition: ApidEnumAc.hpp:31
Telemetry packet type - outgoing.
Definition: ApidEnumAc.hpp:35
U16 SerialType
The serial representation type.
Definition: ApidEnumAc.hpp:28
FormatStatus format(const CHAR *formatString,...)
write formatted string to buffer
Definition: StringBase.cpp:39
Apid & operator=(const Apid &obj)
Copy assignment operator (object)
Definition: ApidEnumAc.cpp:20
F Prime unknown packet.
Definition: ApidEnumAc.hpp:49
Data Product packet type.
Definition: ApidEnumAc.hpp:43
Anything equal or higher value is invalid and should not be used.
Definition: ApidEnumAc.hpp:53
T e
The raw enum value.
Definition: ApidEnumAc.hpp:181
bool isValid() const
Check raw enum value for validity.
Definition: ApidEnumAc.cpp:49
Per Space Packet Standard, all 1s (11bits) is reserved for Idle Packets.
Definition: ApidEnumAc.hpp:51
File type - incoming and outgoing.
Definition: ApidEnumAc.hpp:39
Endianness
APIDs are 11 bits in the Space Packet protocol, so we use U16. Max value 7FF.
Definition: ApidEnumAc.hpp:17
Log type - outgoing.
Definition: ApidEnumAc.hpp:37
Command packet type - incoming.
Definition: ApidEnumAc.hpp:33