F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
TlmSendConfigSerializableAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title TlmSendConfigSerializableAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for TlmSendConfig struct
5 // ======================================================================
6 
7 #ifndef Svc_TlmSendConfigSerializableAc_HPP
8 #define Svc_TlmSendConfigSerializableAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
13 #include "Fw/Types/String.hpp"
16 
17 namespace Svc {
18 
20  class TlmSendConfig :
21  public Fw::Serializable
22  {
23 
24  public:
25 
26  // ----------------------------------------------------------------------
27  // Constants
28  // ----------------------------------------------------------------------
29 
30  enum {
35  };
36 
37  public:
38 
39  // ----------------------------------------------------------------------
40  // Constructors
41  // ----------------------------------------------------------------------
42 
44  TlmSendConfig();
45 
48  Svc::TlmSendState::T sendState,
49  const Svc::RateConfig& rates
50  );
51 
54  const TlmSendConfig& obj
55  );
56 
57  public:
58 
59  // ----------------------------------------------------------------------
60  // Operators
61  // ----------------------------------------------------------------------
62 
65  const TlmSendConfig& obj
66  );
67 
69  bool operator==(
70  const TlmSendConfig& obj
71  ) const;
72 
74  bool operator!=(
75  const TlmSendConfig& obj
76  ) const;
77 
78 #ifdef BUILD_UT
79 
81  friend std::ostream& operator<<(
82  std::ostream& os,
83  const TlmSendConfig& obj
84  );
85 
86 #endif
87 
88  public:
89 
90  // ----------------------------------------------------------------------
91  // Member functions
92  // ----------------------------------------------------------------------
93 
96  Fw::SerialBufferBase& buffer,
98  ) const;
99 
102  Fw::SerialBufferBase& buffer,
104  );
105 
107  FwSizeType serializedSize() const;
108 
109 #if FW_SERIALIZABLE_TO_STRING
110 
112  void toString(
113  Fw::StringBase& sb
114  ) const;
115 
116 #endif
117 
118  // ----------------------------------------------------------------------
119  // Getter functions
120  // ----------------------------------------------------------------------
121 
124  {
125  return this->m_sendState.e;
126  }
127 
130  {
131  return this->m_rates;
132  }
133 
135  const Svc::RateConfig& get_rates() const
136  {
137  return this->m_rates;
138  }
139 
140  // ----------------------------------------------------------------------
141  // Setter functions
142  // ----------------------------------------------------------------------
143 
145  void set(
146  Svc::TlmSendState::T sendState,
147  const Svc::RateConfig& rates
148  );
149 
151  void set_sendState(Svc::TlmSendState::T sendState);
152 
154  void set_rates(const Svc::RateConfig& rates);
155 
156  protected:
157 
158  // ----------------------------------------------------------------------
159  // Member variables
160  // ----------------------------------------------------------------------
161 
164 
165  };
166 
167 }
168 
169 #endif
void set_sendState(Svc::TlmSendState::T sendState)
Set member sendState.
PlatformSizeType FwSizeType
Send policy of a group or packet. Resolution: packet -> group -> section enable.
Telemetry send policy (send state + rates), shared by the per-group config and per-packet override...
void set_rates(const Svc::RateConfig &rates)
Set member rates.
bool operator!=(const TlmSendConfig &obj) const
Inequality operator.
The size of the serial representation.
bool operator==(const TlmSendConfig &obj) const
Equality operator.
Svc::RateConfig & get_rates()
Get member rates.
Svc::TlmSendState::T get_sendState() const
Get member sendState.
SerializeStatus
forward declaration for string
T
The raw enum type.
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialization.
enum T e
The raw enum value.
const Svc::RateConfig & get_rates() const
Get member rates (const)
TlmSendConfig()
Constructor (default value)
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialization.
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
TlmSendConfig & operator=(const TlmSendConfig &obj)
Copy assignment operator.
RateGroupDivider component implementation.
Endianness
The size of the serial representation.
Big endian serialization.
The size of the serial representation.