F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
ChannelTelemetrySerializableAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title ChannelTelemetrySerializableAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for ChannelTelemetry struct
5 // ======================================================================
6 
7 #ifndef Svc_Ccsds_Cfdp_ChannelTelemetrySerializableAc_HPP
8 #define Svc_Ccsds_Cfdp_ChannelTelemetrySerializableAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
13 #include "Fw/Types/String.hpp"
14 
15 namespace Svc {
16 
17  namespace Ccsds {
18 
19  namespace Cfdp {
20 
23  public Fw::Serializable
24  {
25 
26  public:
27 
28  // ----------------------------------------------------------------------
29  // Constants
30  // ----------------------------------------------------------------------
31 
32  enum {
35  sizeof(U32) +
36  sizeof(U32) +
37  sizeof(U32) +
38  sizeof(U64) +
39  sizeof(U32) +
40  sizeof(U32) +
41  sizeof(U32) +
42  sizeof(U32) +
43  sizeof(U64) +
44  sizeof(U32) +
45  sizeof(U32) +
46  sizeof(U32) +
47  sizeof(U32) +
48  sizeof(U32) +
49  sizeof(U32) +
50  sizeof(U32) +
51  sizeof(U32) +
52  sizeof(U32) +
53  sizeof(U32) +
54  sizeof(U32) +
55  sizeof(U32) +
56  sizeof(U32) +
57  sizeof(U32) +
58  sizeof(U32) +
59  sizeof(U16) +
60  sizeof(U16) +
61  sizeof(U16) +
62  sizeof(U16) +
63  sizeof(U16) +
64  sizeof(U8) +
65  sizeof(U8)
66  };
67 
68  public:
69 
70  // ----------------------------------------------------------------------
71  // Constructors
72  // ----------------------------------------------------------------------
73 
76 
79  U32 recvErrors,
80  U32 recvDropped,
81  U32 recvSpurious,
82  U64 recvFileDataBytes,
83  U32 recvNakSegmentRequests,
84  U32 recvPdu,
85  U32 recvEofCanceled,
86  U32 sentNakSegmentRequests,
87  U64 sentFileDataBytes,
88  U32 sentPdu,
89  U32 sentEofCanceled,
90  U32 faultAckLimit,
91  U32 faultNakLimit,
92  U32 faultInactivityTimer,
93  U32 faultCrcMismatch,
94  U32 faultFileSizeMismatch,
95  U32 faultFileOpen,
96  U32 faultFileRead,
97  U32 faultFileWrite,
98  U32 faultFileSeek,
99  U32 faultFileRename,
100  U32 faultDirectoryRead,
101  U32 faultRxEofError,
102  U32 faultTxEofError,
103  U16 queueFree,
104  U16 queueTxActive,
105  U16 queueTxWaiting,
106  U16 queueRx,
107  U16 queueHistory,
108  U8 playbackCounter,
109  U8 pollCounter
110  );
111 
114  const ChannelTelemetry& obj
115  );
116 
117  public:
118 
119  // ----------------------------------------------------------------------
120  // Operators
121  // ----------------------------------------------------------------------
122 
125  const ChannelTelemetry& obj
126  );
127 
129  bool operator==(
130  const ChannelTelemetry& obj
131  ) const;
132 
134  bool operator!=(
135  const ChannelTelemetry& obj
136  ) const;
137 
138 #ifdef BUILD_UT
139 
141  friend std::ostream& operator<<(
142  std::ostream& os,
143  const ChannelTelemetry& obj
144  );
145 
146 #endif
147 
148  public:
149 
150  // ----------------------------------------------------------------------
151  // Member functions
152  // ----------------------------------------------------------------------
153 
156  Fw::SerialBufferBase& buffer,
158  ) const;
159 
162  Fw::SerialBufferBase& buffer,
164  );
165 
167  FwSizeType serializedSize() const;
168 
169 #if FW_SERIALIZABLE_TO_STRING
170 
172  void toString(
173  Fw::StringBase& sb
174  ) const;
175 
176 #endif
177 
178  // ----------------------------------------------------------------------
179  // Getter functions
180  // ----------------------------------------------------------------------
181 
183  U32 get_recvErrors() const
184  {
185  return this->m_recvErrors;
186  }
187 
189  U32 get_recvDropped() const
190  {
191  return this->m_recvDropped;
192  }
193 
195  U32 get_recvSpurious() const
196  {
197  return this->m_recvSpurious;
198  }
199 
202  {
203  return this->m_recvFileDataBytes;
204  }
205 
208  {
209  return this->m_recvNakSegmentRequests;
210  }
211 
213  U32 get_recvPdu() const
214  {
215  return this->m_recvPdu;
216  }
217 
220  {
221  return this->m_recvEofCanceled;
222  }
223 
226  {
227  return this->m_sentNakSegmentRequests;
228  }
229 
232  {
233  return this->m_sentFileDataBytes;
234  }
235 
237  U32 get_sentPdu() const
238  {
239  return this->m_sentPdu;
240  }
241 
244  {
245  return this->m_sentEofCanceled;
246  }
247 
249  U32 get_faultAckLimit() const
250  {
251  return this->m_faultAckLimit;
252  }
253 
255  U32 get_faultNakLimit() const
256  {
257  return this->m_faultNakLimit;
258  }
259 
262  {
263  return this->m_faultInactivityTimer;
264  }
265 
268  {
269  return this->m_faultCrcMismatch;
270  }
271 
274  {
275  return this->m_faultFileSizeMismatch;
276  }
277 
279  U32 get_faultFileOpen() const
280  {
281  return this->m_faultFileOpen;
282  }
283 
285  U32 get_faultFileRead() const
286  {
287  return this->m_faultFileRead;
288  }
289 
291  U32 get_faultFileWrite() const
292  {
293  return this->m_faultFileWrite;
294  }
295 
297  U32 get_faultFileSeek() const
298  {
299  return this->m_faultFileSeek;
300  }
301 
304  {
305  return this->m_faultFileRename;
306  }
307 
310  {
311  return this->m_faultDirectoryRead;
312  }
313 
316  {
317  return this->m_faultRxEofError;
318  }
319 
322  {
323  return this->m_faultTxEofError;
324  }
325 
327  U16 get_queueFree() const
328  {
329  return this->m_queueFree;
330  }
331 
333  U16 get_queueTxActive() const
334  {
335  return this->m_queueTxActive;
336  }
337 
339  U16 get_queueTxWaiting() const
340  {
341  return this->m_queueTxWaiting;
342  }
343 
345  U16 get_queueRx() const
346  {
347  return this->m_queueRx;
348  }
349 
351  U16 get_queueHistory() const
352  {
353  return this->m_queueHistory;
354  }
355 
358  {
359  return this->m_playbackCounter;
360  }
361 
364  {
365  return this->m_pollCounter;
366  }
367 
368  // ----------------------------------------------------------------------
369  // Setter functions
370  // ----------------------------------------------------------------------
371 
373  void set(
374  U32 recvErrors,
375  U32 recvDropped,
376  U32 recvSpurious,
377  U64 recvFileDataBytes,
378  U32 recvNakSegmentRequests,
379  U32 recvPdu,
380  U32 recvEofCanceled,
381  U32 sentNakSegmentRequests,
382  U64 sentFileDataBytes,
383  U32 sentPdu,
384  U32 sentEofCanceled,
385  U32 faultAckLimit,
386  U32 faultNakLimit,
387  U32 faultInactivityTimer,
388  U32 faultCrcMismatch,
389  U32 faultFileSizeMismatch,
390  U32 faultFileOpen,
391  U32 faultFileRead,
392  U32 faultFileWrite,
393  U32 faultFileSeek,
394  U32 faultFileRename,
395  U32 faultDirectoryRead,
396  U32 faultRxEofError,
397  U32 faultTxEofError,
398  U16 queueFree,
399  U16 queueTxActive,
400  U16 queueTxWaiting,
401  U16 queueRx,
402  U16 queueHistory,
403  U8 playbackCounter,
404  U8 pollCounter
405  );
406 
408  void set_recvErrors(U32 recvErrors);
409 
411  void set_recvDropped(U32 recvDropped);
412 
414  void set_recvSpurious(U32 recvSpurious);
415 
417  void set_recvFileDataBytes(U64 recvFileDataBytes);
418 
420  void set_recvNakSegmentRequests(U32 recvNakSegmentRequests);
421 
423  void set_recvPdu(U32 recvPdu);
424 
426  void set_recvEofCanceled(U32 recvEofCanceled);
427 
429  void set_sentNakSegmentRequests(U32 sentNakSegmentRequests);
430 
432  void set_sentFileDataBytes(U64 sentFileDataBytes);
433 
435  void set_sentPdu(U32 sentPdu);
436 
438  void set_sentEofCanceled(U32 sentEofCanceled);
439 
441  void set_faultAckLimit(U32 faultAckLimit);
442 
444  void set_faultNakLimit(U32 faultNakLimit);
445 
447  void set_faultInactivityTimer(U32 faultInactivityTimer);
448 
450  void set_faultCrcMismatch(U32 faultCrcMismatch);
451 
453  void set_faultFileSizeMismatch(U32 faultFileSizeMismatch);
454 
456  void set_faultFileOpen(U32 faultFileOpen);
457 
459  void set_faultFileRead(U32 faultFileRead);
460 
462  void set_faultFileWrite(U32 faultFileWrite);
463 
465  void set_faultFileSeek(U32 faultFileSeek);
466 
468  void set_faultFileRename(U32 faultFileRename);
469 
471  void set_faultDirectoryRead(U32 faultDirectoryRead);
472 
474  void set_faultRxEofError(U32 faultRxEofError);
475 
477  void set_faultTxEofError(U32 faultTxEofError);
478 
480  void set_queueFree(U16 queueFree);
481 
483  void set_queueTxActive(U16 queueTxActive);
484 
486  void set_queueTxWaiting(U16 queueTxWaiting);
487 
489  void set_queueRx(U16 queueRx);
490 
492  void set_queueHistory(U16 queueHistory);
493 
495  void set_playbackCounter(U8 playbackCounter);
496 
498  void set_pollCounter(U8 pollCounter);
499 
500  protected:
501 
502  // ----------------------------------------------------------------------
503  // Member variables
504  // ----------------------------------------------------------------------
505 
537 
538  };
539 
540  }
541 
542  }
543 
544 }
545 
546 #endif
U32 get_recvSpurious() const
Get member recvSpurious.
U32 get_faultFileWrite() const
Get member faultFileWrite.
void set_faultCrcMismatch(U32 faultCrcMismatch)
Set member faultCrcMismatch.
void set_recvSpurious(U32 recvSpurious)
Set member recvSpurious.
PlatformSizeType FwSizeType
bool operator==(const ChannelTelemetry &obj) const
Equality operator.
void set_faultFileSeek(U32 faultFileSeek)
Set member faultFileSeek.
U32 get_faultInactivityTimer() const
Get member faultInactivityTimer.
void set_sentNakSegmentRequests(U32 sentNakSegmentRequests)
Set member sentNakSegmentRequests.
void set_recvEofCanceled(U32 recvEofCanceled)
Set member recvEofCanceled.
void set_faultRxEofError(U32 faultRxEofError)
Set member faultRxEofError.
U32 get_faultRxEofError() const
Get member faultRxEofError.
void set_queueTxActive(U16 queueTxActive)
Set member queueTxActive.
U32 get_faultNakLimit() const
Get member faultNakLimit.
void set_recvNakSegmentRequests(U32 recvNakSegmentRequests)
Set member recvNakSegmentRequests.
U32 get_recvEofCanceled() const
Get member recvEofCanceled.
U8 get_playbackCounter() const
Get member playbackCounter.
U32 get_faultFileSeek() const
Get member faultFileSeek.
U32 get_recvErrors() const
Get member recvErrors.
void set_sentFileDataBytes(U64 sentFileDataBytes)
Set member sentFileDataBytes.
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialization.
void set_pollCounter(U8 pollCounter)
Set member pollCounter.
U32 get_faultDirectoryRead() const
Get member faultDirectoryRead.
U32 get_faultFileSizeMismatch() const
Get member faultFileSizeMismatch.
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
void set_recvFileDataBytes(U64 recvFileDataBytes)
Set member recvFileDataBytes.
SerializeStatus
forward declaration for string
U8 get_pollCounter() const
Get member pollCounter.
void set_queueTxWaiting(U16 queueTxWaiting)
Set member queueTxWaiting.
U16 get_queueTxActive() const
Get member queueTxActive.
void set_sentPdu(U32 sentPdu)
Set member sentPdu.
void set_queueRx(U16 queueRx)
Set member queueRx.
U32 get_faultFileRead() const
Get member faultFileRead.
U32 get_faultFileRename() const
Get member faultFileRename.
bool operator!=(const ChannelTelemetry &obj) const
Inequality operator.
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialization.
U16 get_queueTxWaiting() const
Get member queueTxWaiting.
void set_faultAckLimit(U32 faultAckLimit)
Set member faultAckLimit.
void set_faultDirectoryRead(U32 faultDirectoryRead)
Set member faultDirectoryRead.
void set_recvDropped(U32 recvDropped)
Set member recvDropped.
U32 get_recvDropped() const
Get member recvDropped.
void set_faultInactivityTimer(U32 faultInactivityTimer)
Set member faultInactivityTimer.
U16 get_queueFree() const
Get member queueFree.
U64 get_sentFileDataBytes() const
Get member sentFileDataBytes.
void set_faultTxEofError(U32 faultTxEofError)
Set member faultTxEofError.
void set_faultFileOpen(U32 faultFileOpen)
Set member faultFileOpen.
U32 get_faultCrcMismatch() const
Get member faultCrcMismatch.
void set_faultFileRename(U32 faultFileRename)
Set member faultFileRename.
void set_recvPdu(U32 recvPdu)
Set member recvPdu.
void set_faultNakLimit(U32 faultNakLimit)
Set member faultNakLimit.
U32 get_sentNakSegmentRequests() const
Get member sentNakSegmentRequests.
U32 get_recvNakSegmentRequests() const
Get member recvNakSegmentRequests.
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:54
void set_playbackCounter(U8 playbackCounter)
Set member playbackCounter.
void set_faultFileWrite(U32 faultFileWrite)
Set member faultFileWrite.
void set_faultFileRead(U32 faultFileRead)
Set member faultFileRead.
U64 get_recvFileDataBytes() const
Get member recvFileDataBytes.
Structure for the telemetry array of CFDP channels.
RateGroupDivider component implementation.
U32 get_faultAckLimit() const
Get member faultAckLimit.
void set_faultFileSizeMismatch(U32 faultFileSizeMismatch)
Set member faultFileSizeMismatch.
U32 get_sentEofCanceled() const
Get member sentEofCanceled.
Endianness
void set_queueHistory(U16 queueHistory)
Set member queueHistory.
U16 get_queueHistory() const
Get member queueHistory.
void set_queueFree(U16 queueFree)
Set member queueFree.
U32 get_faultTxEofError() const
Get member faultTxEofError.
U32 get_faultFileOpen() const
Get member faultFileOpen.
Big endian serialization.
ChannelTelemetry & operator=(const ChannelTelemetry &obj)
Copy assignment operator.
void set_sentEofCanceled(U32 sentEofCanceled)
Set member sentEofCanceled.
void set_recvErrors(U32 recvErrors)
Set member recvErrors.
#define U64(C)
Definition: sha.h:181