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  {
59  const Fw::SerializeStatus status = buffer.serializeFrom(
60  static_cast<SerialType>(this->e)
61  );
62  return status;
63  }
64 
67  {
68  SerialType es;
69  Fw::SerializeStatus status = buffer.deserializeTo(es);
70  if (status == Fw::FW_SERIALIZE_OK) {
71  this->e = static_cast<T>(es);
72  if (!this->isValid()) {
74  }
75  }
76  return status;
77  }
78 
79 #if FW_SERIALIZABLE_TO_STRING
80 
81  void Apid ::
82  toString(Fw::StringBase& sb) const
83  {
84  Fw::String s;
85  switch (e) {
86  case FW_PACKET_COMMAND:
87  s = "FW_PACKET_COMMAND";
88  break;
89  case FW_PACKET_TELEM:
90  s = "FW_PACKET_TELEM";
91  break;
92  case FW_PACKET_LOG:
93  s = "FW_PACKET_LOG";
94  break;
95  case FW_PACKET_FILE:
96  s = "FW_PACKET_FILE";
97  break;
99  s = "FW_PACKET_PACKETIZED_TLM";
100  break;
101  case FW_PACKET_DP:
102  s = "FW_PACKET_DP";
103  break;
104  case FW_PACKET_IDLE:
105  s = "FW_PACKET_IDLE";
106  break;
107  case FW_PACKET_HAND:
108  s = "FW_PACKET_HAND";
109  break;
110  case FW_PACKET_UNKNOWN:
111  s = "FW_PACKET_UNKNOWN";
112  break;
113  case SPP_IDLE_PACKET:
114  s = "SPP_IDLE_PACKET";
115  break;
117  s = "INVALID_UNINITIALIZED";
118  break;
119  default:
120  s = "[invalid]";
121  break;
122  }
123  sb.format("%s (%" PRIu16 ")", s.toChar(), e);
124  }
125 
126 #elif FW_ENABLE_TEXT_LOGGING
127 
128  void Apid ::
129  toString(Fw::StringBase& sb) const
130  {
131  sb.format("%" PRIu16 "", e);
132  }
133 
134 #endif
135 
136 }
Serialization/Deserialization operation was successful.
Packetized telemetry packet type.
Definition: ApidEnumAc.hpp:41
const char * toChar() const
Definition: String.hpp:50
Deserialization data had incorrect values (unexpected data types)
SerializeStatus
forward declaration for string
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
Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase &buffer)
Deserialize raw enum value from SerialType.
Definition: ApidEnumAc.cpp:66
FormatStatus format(const CHAR *formatString,...)
write formatted string to buffer
Definition: StringBase.cpp:55
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
Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase &buffer) const
Serialize raw enum value to SerialType.
Definition: ApidEnumAc.cpp:57
T e
The raw enum value.
Definition: ApidEnumAc.hpp:179
bool isValid() const
Check raw enum value for validity.
Definition: ApidEnumAc.cpp:49
SerializeStatus serializeFrom(U8 val)
serialize 8-bit unsigned int
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
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
SerializeStatus deserializeTo(U8 &val)
deserialize 8-bit unsigned int
Command packet type - incoming.
Definition: ApidEnumAc.hpp:33