F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TCHeaderSerializableAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title TCHeaderSerializableAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for TCHeader struct
5 // ======================================================================
6 
7 #ifndef Svc_CCSDS_TCHeaderSerializableAc_HPP
8 #define Svc_CCSDS_TCHeaderSerializableAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
13 #include "Fw/Types/String.hpp"
14 
15 namespace Svc {
16 
17  namespace CCSDS {
18 
20  class TCHeader :
21  public Fw::Serializable
22  {
23 
24  public:
25 
26  // ----------------------------------------------------------------------
27  // Constants
28  // ----------------------------------------------------------------------
29 
30  enum {
33  sizeof(U16) +
34  sizeof(U16) +
35  sizeof(U8)
36  };
37 
38  public:
39 
40  // ----------------------------------------------------------------------
41  // Constructors
42  // ----------------------------------------------------------------------
43 
45  TCHeader();
46 
48  TCHeader(
49  U16 flagsAndScId,
50  U16 vcIdAndLength,
51  U8 frameSequenceNum
52  );
53 
55  TCHeader(
56  const TCHeader& obj
57  );
58 
59  public:
60 
61  // ----------------------------------------------------------------------
62  // Operators
63  // ----------------------------------------------------------------------
64 
67  const TCHeader& obj
68  );
69 
71  bool operator==(
72  const TCHeader& obj
73  ) const;
74 
76  bool operator!=(
77  const TCHeader& obj
78  ) const;
79 
80 #ifdef BUILD_UT
81 
83  friend std::ostream& operator<<(
84  std::ostream& os,
85  const TCHeader& obj
86  );
87 
88 #endif
89 
90  public:
91 
92  // ----------------------------------------------------------------------
93  // Member functions
94  // ----------------------------------------------------------------------
95 
99  ) const;
100 
103  Fw::SerializeBufferBase& buffer
104  );
105 
106 #if FW_SERIALIZABLE_TO_STRING
107 
109  void toString(
110  Fw::StringBase& sb
111  ) const;
112 
113 #endif
114 
115  // ----------------------------------------------------------------------
116  // Getter functions
117  // ----------------------------------------------------------------------
118 
120  U16 getflagsAndScId() const
121  {
122  return this->m_flagsAndScId;
123  }
124 
126  U16 getvcIdAndLength() const
127  {
128  return this->m_vcIdAndLength;
129  }
130 
133  {
134  return this->m_frameSequenceNum;
135  }
136 
137  // ----------------------------------------------------------------------
138  // Setter functions
139  // ----------------------------------------------------------------------
140 
142  void set(
143  U16 flagsAndScId,
144  U16 vcIdAndLength,
145  U8 frameSequenceNum
146  );
147 
149  void setflagsAndScId(U16 flagsAndScId);
150 
152  void setvcIdAndLength(U16 vcIdAndLength);
153 
155  void setframeSequenceNum(U8 frameSequenceNum);
156 
157  protected:
158 
159  // ----------------------------------------------------------------------
160  // Member variables
161  // ----------------------------------------------------------------------
162 
166 
167  };
168 
169  }
170 
171 }
172 
173 #endif
U16 getflagsAndScId() const
Get member flagsAndScId.
Describes the frame header format for a Telecommand (TC) Transfer Frame header.
void setframeSequenceNum(U8 frameSequenceNum)
Set member frameSequenceNum.
The size of the serial representation.
Fw::SerializeStatus deserialize(Fw::SerializeBufferBase &buffer)
Deserialization.
SerializeStatus
forward declaration for string
TCHeader()
Constructor (default value)
void setvcIdAndLength(U16 vcIdAndLength)
Set member vcIdAndLength.
Fw::SerializeStatus serialize(Fw::SerializeBufferBase &buffer) const
Serialization.
U8 getframeSequenceNum() const
Get member frameSequenceNum.
U16 getvcIdAndLength() const
Get member vcIdAndLength.
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:56
bool operator==(const TCHeader &obj) const
Equality operator.
forward declaration
RateGroupDivider component implementation.
bool operator!=(const TCHeader &obj) const
Inequality operator.
TCHeader & operator=(const TCHeader &obj)
Copy assignment operator.
void setflagsAndScId(U16 flagsAndScId)
Set member flagsAndScId.