F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TCHeaderSerializableAc.cpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title TCHeaderSerializableAc.cpp
3 // \author Generated by fpp-to-cpp
4 // \brief cpp file for TCHeader struct
5 // ======================================================================
6 
7 #include "Fw/Types/Assert.hpp"
9 
10 namespace Svc {
11 
12  namespace Ccsds {
13 
14  // ----------------------------------------------------------------------
15  // Constructors
16  // ----------------------------------------------------------------------
17 
20  Serializable(),
21  m_flagsAndScId(0),
22  m_vcIdAndLength(0),
23  m_frameSequenceNum(0)
24  {
25 
26  }
27 
30  U16 flagsAndScId,
31  U16 vcIdAndLength,
32  U8 frameSequenceNum
33  ) :
34  Serializable(),
35  m_flagsAndScId(flagsAndScId),
36  m_vcIdAndLength(vcIdAndLength),
37  m_frameSequenceNum(frameSequenceNum)
38  {
39 
40  }
41 
43  TCHeader(const TCHeader& obj) :
44  Serializable(),
45  m_flagsAndScId(obj.m_flagsAndScId),
46  m_vcIdAndLength(obj.m_vcIdAndLength),
47  m_frameSequenceNum(obj.m_frameSequenceNum)
48  {
49 
50  }
51 
52  // ----------------------------------------------------------------------
53  // Operators
54  // ----------------------------------------------------------------------
55 
57  operator=(const TCHeader& obj)
58  {
59  if (this == &obj) {
60  return *this;
61  }
62 
64  return *this;
65  }
66 
67  bool TCHeader ::
68  operator==(const TCHeader& obj) const
69  {
70  if (this == &obj) { return true; }
71  return (
72  (this->m_flagsAndScId == obj.m_flagsAndScId) &&
73  (this->m_vcIdAndLength == obj.m_vcIdAndLength) &&
74  (this->m_frameSequenceNum == obj.m_frameSequenceNum)
75  );
76  }
77 
78  bool TCHeader ::
79  operator!=(const TCHeader& obj) const
80  {
81  return !(*this == obj);
82  }
83 
84 #ifdef BUILD_UT
85 
86  std::ostream& operator<<(std::ostream& os, const TCHeader& obj) {
87  Fw::String s;
88  obj.toString(s);
89  os << s.toChar();
90  return os;
91  }
92 
93 #endif
94 
95  // ----------------------------------------------------------------------
96  // Member functions
97  // ----------------------------------------------------------------------
98 
101  Fw::SerialBufferBase& buffer,
102  Fw::Endianness mode
103  ) const
104  {
105  Fw::SerializeStatus status;
106 
107  status = buffer.serializeFrom(this->m_flagsAndScId, mode);
108  if (status != Fw::FW_SERIALIZE_OK) {
109  return status;
110  }
111  status = buffer.serializeFrom(this->m_vcIdAndLength, mode);
112  if (status != Fw::FW_SERIALIZE_OK) {
113  return status;
114  }
115  status = buffer.serializeFrom(this->m_frameSequenceNum, mode);
116  if (status != Fw::FW_SERIALIZE_OK) {
117  return status;
118  }
119 
120  return status;
121  }
122 
125  Fw::SerialBufferBase& buffer,
126  Fw::Endianness mode
127  )
128  {
129  Fw::SerializeStatus status;
130 
131  status = buffer.deserializeTo(this->m_flagsAndScId, mode);
132  if (status != Fw::FW_SERIALIZE_OK) {
133  return status;
134  }
135  status = buffer.deserializeTo(this->m_vcIdAndLength, mode);
136  if (status != Fw::FW_SERIALIZE_OK) {
137  return status;
138  }
139  status = buffer.deserializeTo(this->m_frameSequenceNum, mode);
140  if (status != Fw::FW_SERIALIZE_OK) {
141  return status;
142  }
143 
144  return status;
145  }
146 
149  {
150  FwSizeType size = 0;
151  size += sizeof(U16);
152  size += sizeof(U16);
153  size += sizeof(U8);
154  return size;
155  }
156 
157 #if FW_SERIALIZABLE_TO_STRING
158 
159  void TCHeader ::
160  toString(Fw::StringBase& sb) const
161  {
162  Fw::String tmp;
163  sb = "( ";
164 
165  // Format flagsAndScId
166  sb += "flagsAndScId = ";
167  tmp.format("%" PRIu16 "", this->m_flagsAndScId);
168  sb += tmp;
169  sb += ", ";
170 
171  // Format vcIdAndLength
172  sb += "vcIdAndLength = ";
173  tmp.format("%" PRIu16 "", this->m_vcIdAndLength);
174  sb += tmp;
175  sb += ", ";
176 
177  // Format frameSequenceNum
178  sb += "frameSequenceNum = ";
179  tmp.format("%" PRIu8 "", this->m_frameSequenceNum);
180  sb += tmp;
181  sb += " )";
182  }
183 
184 #endif
185 
186  // ----------------------------------------------------------------------
187  // Setter functions
188  // ----------------------------------------------------------------------
189 
190  void TCHeader ::
192  U16 flagsAndScId,
193  U16 vcIdAndLength,
194  U8 frameSequenceNum
195  )
196  {
197  this->m_flagsAndScId = flagsAndScId;
198  this->m_vcIdAndLength = vcIdAndLength;
199  this->m_frameSequenceNum = frameSequenceNum;
200  }
201 
202  void TCHeader ::
203  set_flagsAndScId(U16 flagsAndScId)
204  {
205  this->m_flagsAndScId = flagsAndScId;
206  }
207 
208  void TCHeader ::
209  set_vcIdAndLength(U16 vcIdAndLength)
210  {
211  this->m_vcIdAndLength = vcIdAndLength;
212  }
213 
214  void TCHeader ::
215  set_frameSequenceNum(U8 frameSequenceNum)
216  {
217  this->m_frameSequenceNum = frameSequenceNum;
218  }
219 
220  }
221 
222 }
Serialization/Deserialization operation was successful.
TCHeader()
Constructor (default value)
PlatformSizeType FwSizeType
const char * toChar() const
Convert to a C-style char*.
Definition: String.hpp:50
void set_frameSequenceNum(U8 frameSequenceNum)
Set member frameSequenceNum.
virtual SerializeStatus serializeFrom(U8 val, Endianness mode=Endianness::BIG)=0
Serialize an 8-bit unsigned integer value.
void set_vcIdAndLength(U16 vcIdAndLength)
Set member vcIdAndLength.
SerializeStatus
forward declaration for string
virtual SerializeStatus deserializeTo(U8 &val, Endianness mode=Endianness::BIG)=0
Deserialize an 8-bit unsigned integer value.
bool operator!=(const TCHeader &obj) const
Inequality operator.
Describes the frame header format for a Telecommand (TC) Transfer Frame header.
TCHeader & operator=(const TCHeader &obj)
Copy assignment operator.
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialization.
FormatStatus format(const CHAR *formatString,...)
write formatted string to buffer
Definition: StringBase.cpp:39
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:53
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialization.
void set_flagsAndScId(U16 flagsAndScId)
Set member flagsAndScId.
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
bool operator==(const TCHeader &obj) const
Equality operator.
RateGroupDivider component implementation.
Endianness
void set(U16 flagsAndScId, U16 vcIdAndLength, U8 frameSequenceNum)
Set all members.