F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
ChannelParamsSerializableAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title ChannelParamsSerializableAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for ChannelParams struct
5 // ======================================================================
6 
7 #ifndef Svc_Ccsds_Cfdp_ChannelParamsSerializableAc_HPP
8 #define Svc_Ccsds_Cfdp_ChannelParamsSerializableAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
14 #include "Fw/Types/String.hpp"
16 
17 namespace Svc {
18 
19  namespace Ccsds {
20 
21  namespace Cfdp {
22 
24  class ChannelParams :
25  public Fw::Serializable
26  {
27 
28  public:
29 
30  // ----------------------------------------------------------------------
31  // Constants
32  // ----------------------------------------------------------------------
33 
34  enum {
37  sizeof(U8) +
38  sizeof(U8) +
39  sizeof(U32) +
40  sizeof(U32) +
43  sizeof(U32) +
47  };
48 
49  public:
50 
51  // ----------------------------------------------------------------------
52  // Constructors
53  // ----------------------------------------------------------------------
54 
56  ChannelParams();
57 
60  U8 ack_limit,
61  U8 nack_limit,
62  U32 ack_timer,
63  U32 inactivity_timer,
64  Fw::Enabled::T dequeue_enabled,
65  const Fw::StringBase& move_dir,
66  U32 max_outgoing_pdus_per_cycle,
67  const Fw::StringBase& tmp_dir,
68  const Fw::StringBase& fail_dir,
69  const Fw::StringBase& rx_dir
70  );
71 
74  const ChannelParams& obj
75  );
76 
77  public:
78 
79  // ----------------------------------------------------------------------
80  // Operators
81  // ----------------------------------------------------------------------
82 
85  const ChannelParams& obj
86  );
87 
89  bool operator==(
90  const ChannelParams& obj
91  ) const;
92 
94  bool operator!=(
95  const ChannelParams& obj
96  ) const;
97 
98 #ifdef BUILD_UT
99 
101  friend std::ostream& operator<<(
102  std::ostream& os,
103  const ChannelParams& obj
104  );
105 
106 #endif
107 
108  public:
109 
110  // ----------------------------------------------------------------------
111  // Member functions
112  // ----------------------------------------------------------------------
113 
116  Fw::SerialBufferBase& buffer,
118  ) const;
119 
122  Fw::SerialBufferBase& buffer,
124  );
125 
127  FwSizeType serializedSize() const;
128 
129 #if FW_SERIALIZABLE_TO_STRING
130 
132  void toString(
133  Fw::StringBase& sb
134  ) const;
135 
136 #endif
137 
138  // ----------------------------------------------------------------------
139  // Getter functions
140  // ----------------------------------------------------------------------
141 
144  {
145  return this->m_ack_limit;
146  }
147 
150  {
151  return this->m_nack_limit;
152  }
153 
155  U32 get_ack_timer() const
156  {
157  return this->m_ack_timer;
158  }
159 
162  {
163  return this->m_inactivity_timer;
164  }
165 
168  {
169  return this->m_dequeue_enabled.e;
170  }
171 
174  {
175  return this->m_move_dir;
176  }
177 
180  {
181  return this->m_move_dir;
182  }
183 
186  {
187  return this->m_max_outgoing_pdus_per_cycle;
188  }
189 
192  {
193  return this->m_tmp_dir;
194  }
195 
198  {
199  return this->m_tmp_dir;
200  }
201 
204  {
205  return this->m_fail_dir;
206  }
207 
210  {
211  return this->m_fail_dir;
212  }
213 
216  {
217  return this->m_rx_dir;
218  }
219 
222  {
223  return this->m_rx_dir;
224  }
225 
226  // ----------------------------------------------------------------------
227  // Setter functions
228  // ----------------------------------------------------------------------
229 
231  void set(
232  U8 ack_limit,
233  U8 nack_limit,
234  U32 ack_timer,
235  U32 inactivity_timer,
236  Fw::Enabled::T dequeue_enabled,
237  const Fw::StringBase& move_dir,
238  U32 max_outgoing_pdus_per_cycle,
239  const Fw::StringBase& tmp_dir,
240  const Fw::StringBase& fail_dir,
241  const Fw::StringBase& rx_dir
242  );
243 
245  void set_ack_limit(U8 ack_limit);
246 
248  void set_nack_limit(U8 nack_limit);
249 
251  void set_ack_timer(U32 ack_timer);
252 
254  void set_inactivity_timer(U32 inactivity_timer);
255 
257  void set_dequeue_enabled(Fw::Enabled::T dequeue_enabled);
258 
260  void set_move_dir(const Fw::StringBase& move_dir);
261 
263  void set_max_outgoing_pdus_per_cycle(U32 max_outgoing_pdus_per_cycle);
264 
266  void set_tmp_dir(const Fw::StringBase& tmp_dir);
267 
269  void set_fail_dir(const Fw::StringBase& fail_dir);
270 
272  void set_rx_dir(const Fw::StringBase& rx_dir);
273 
274  protected:
275 
276  // ----------------------------------------------------------------------
277  // Member variables
278  // ----------------------------------------------------------------------
279 
294 
295  };
296 
297  }
298 
299  }
300 
301 }
302 
303 #endif
char m___fprime_ac_rx_dir_buffer[Fw::StringBase::BUFFER_SIZE(200)]
void set_ack_timer(U32 ack_timer)
Set member ack_timer.
bool operator!=(const ChannelParams &obj) const
Inequality operator.
PlatformSizeType FwSizeType
Fw::ExternalString & get_move_dir()
Get member move_dir.
char m___fprime_ac_fail_dir_buffer[Fw::StringBase::BUFFER_SIZE(200)]
void set_rx_dir(const Fw::StringBase &rx_dir)
Set member rx_dir.
void set_ack_limit(U8 ack_limit)
Set member ack_limit.
void set_inactivity_timer(U32 inactivity_timer)
Set member inactivity_timer.
The size of the serial representation.
void set_tmp_dir(const Fw::StringBase &tmp_dir)
Set member tmp_dir.
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
void set_nack_limit(U8 nack_limit)
Set member nack_limit.
ChannelParams & operator=(const ChannelParams &obj)
Copy assignment operator.
enum T e
The raw enum value.
Fw::ExternalString & get_tmp_dir()
Get member tmp_dir.
const Fw::ExternalString & get_fail_dir() const
Get member fail_dir (const)
ChannelParams()
Constructor (default value)
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialization.
SerializeStatus
forward declaration for string
void set_move_dir(const Fw::StringBase &move_dir)
Set member move_dir.
const Fw::ExternalString & get_move_dir() const
Get member move_dir (const)
const Fw::ExternalString & get_tmp_dir() const
Get member tmp_dir (const)
U8 get_ack_limit() const
Get member ack_limit.
const Fw::ExternalString & get_rx_dir() const
Get member rx_dir (const)
void set_fail_dir(const Fw::StringBase &fail_dir)
Set member fail_dir.
void set_dequeue_enabled(Fw::Enabled::T dequeue_enabled)
Set member dequeue_enabled.
char m___fprime_ac_move_dir_buffer[Fw::StringBase::BUFFER_SIZE(200)]
A string backed by an external buffer.
Enabled and disabled states.
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:54
Structure for the configured array of CFDP channels.
Fw::ExternalString & get_rx_dir()
Get member rx_dir.
U32 get_inactivity_timer() const
Get member inactivity_timer.
U32 get_max_outgoing_pdus_per_cycle() const
Get member max_outgoing_pdus_per_cycle.
U32 get_ack_timer() const
Get member ack_timer.
Fw::Enabled::T get_dequeue_enabled() const
Get member dequeue_enabled.
bool operator==(const ChannelParams &obj) const
Equality operator.
RateGroupDivider component implementation.
static constexpr SizeType STATIC_SERIALIZED_SIZE(SizeType maxLength)
Fw::ExternalString & get_fail_dir()
Get member fail_dir.
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialization.
Endianness
static constexpr SizeType BUFFER_SIZE(SizeType maxLength)
Get the size of a null-terminated string buffer.
char m___fprime_ac_tmp_dir_buffer[Fw::StringBase::BUFFER_SIZE(200)]
U8 get_nack_limit() const
Get member nack_limit.
Big endian serialization.
T
The raw enum type.
void set_max_outgoing_pdus_per_cycle(U32 max_outgoing_pdus_per_cycle)
Set member max_outgoing_pdus_per_cycle.