F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
CustomVersionDbSerializableAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title CustomVersionDbSerializableAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for CustomVersionDb struct
5 // ======================================================================
6 
7 #ifndef Svc_CustomVersionDbSerializableAc_HPP
8 #define Svc_CustomVersionDbSerializableAc_HPP
9 
10 #include "Fw/FPrimeBasicTypes.hpp"
13 #include "Fw/Types/String.hpp"
16 
17 namespace Svc {
18 
21  public Fw::Serializable
22  {
23 
24  public:
25 
26  // ----------------------------------------------------------------------
27  // Constants
28  // ----------------------------------------------------------------------
29 
30  enum {
36  };
37 
38  public:
39 
40  // ----------------------------------------------------------------------
41  // Constructors
42  // ----------------------------------------------------------------------
43 
46 
50  const Fw::StringBase& version_value,
51  Svc::VersionStatus::T version_status
52  );
53 
56  const CustomVersionDb& obj
57  );
58 
59  public:
60 
61  // ----------------------------------------------------------------------
62  // Operators
63  // ----------------------------------------------------------------------
64 
67  const CustomVersionDb& obj
68  );
69 
71  bool operator==(
72  const CustomVersionDb& obj
73  ) const;
74 
76  bool operator!=(
77  const CustomVersionDb& obj
78  ) const;
79 
80 #ifdef BUILD_UT
81 
83  friend std::ostream& operator<<(
84  std::ostream& os,
85  const CustomVersionDb& obj
86  );
87 
88 #endif
89 
90  public:
91 
92  // ----------------------------------------------------------------------
93  // Member functions
94  // ----------------------------------------------------------------------
95 
98  Fw::SerialBufferBase& buffer,
100  ) const;
101 
104  Fw::SerialBufferBase& buffer,
106  );
107 
109  FwSizeType serializedSize() const;
110 
111 #if FW_SERIALIZABLE_TO_STRING
112 
114  void toString(
115  Fw::StringBase& sb
116  ) const;
117 
118 #endif
119 
120  // ----------------------------------------------------------------------
121  // Getter functions
122  // ----------------------------------------------------------------------
123 
126  {
127  return this->m_version_enum.e;
128  }
129 
132  {
133  return this->m_version_value;
134  }
135 
138  {
139  return this->m_version_value;
140  }
141 
144  {
145  return this->m_version_status.e;
146  }
147 
148  // ----------------------------------------------------------------------
149  // Setter functions
150  // ----------------------------------------------------------------------
151 
153  void set(
154  Svc::VersionCfg::VersionEnum::T version_enum,
155  const Fw::StringBase& version_value,
156  Svc::VersionStatus::T version_status
157  );
158 
161 
163  void set_version_value(const Fw::StringBase& version_value);
164 
166  void set_version_status(Svc::VersionStatus::T version_status);
167 
168  protected:
169 
170  // ----------------------------------------------------------------------
171  // Member variables
172  // ----------------------------------------------------------------------
173 
178 
179  };
180 
181 }
182 
183 #endif
void set_version_value(const Fw::StringBase &version_value)
Set member version_value.
CustomVersionDb & operator=(const CustomVersionDb &obj)
Copy assignment operator.
void set_version_status(Svc::VersionStatus::T version_status)
Set member version_status.
PlatformSizeType FwSizeType
The size of the serial representation.
Svc::VersionStatus::T get_version_status() const
Get member version_status.
SerializeStatus
forward declaration for string
T e
The raw enum value.
An enumeration for version status.
void set_version_enum(Svc::VersionCfg::VersionEnum::T version_enum)
Set member version_enum.
T
The raw enum type.
const Fw::ExternalString & get_version_value() const
Get member version_value (const)
Fw::SerializeStatus serializeTo(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
Serialization.
bool operator==(const CustomVersionDb &obj) const
Equality operator.
The size of the serial representation.
Svc::VersionCfg::VersionEnum::T get_version_enum() const
Get member version_enum.
A string backed by an external buffer.
Fw::ExternalString & get_version_value()
Get member version_value.
Data Structure for custom version Tlm.
char m___fprime_ac_version_value_buffer[Fw::StringBase::BUFFER_SIZE(80)]
CustomVersionDb()
Constructor (default value)
The size of the serial representation.
FwSizeType serializedSize() const
Get the dynamic serialized size of the struct.
bool operator!=(const CustomVersionDb &obj) const
Inequality operator.
RateGroupDivider component implementation.
static constexpr SizeType STATIC_SERIALIZED_SIZE(SizeType maxLength)
Endianness
static constexpr SizeType BUFFER_SIZE(SizeType maxLength)
Get the size of a null-terminated string buffer.
Svc::VersionCfg::VersionEnum m_version_enum
Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
Deserialization.
Big endian serialization.