F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Version.cpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title Version.cpp
3 // \author sreddy
4 // \brief cpp file for Version component implementation class
5 // ======================================================================
6 
9 
10 #include "versions/version.hpp" //autogenerated file containing hardcoded project and framework versions
11 
12 namespace Svc {
13 
14 // ----------------------------------------------------------------------
15 // Component construction and destruction
16 // ----------------------------------------------------------------------
17 
18 Version ::Version(const char* const compName)
19  : VersionComponentBase(compName), m_enable(false), m_num_custom_elements(0) {
20  Fw::String version_string = "no_ver";
21  // initialize all custom entries
23  // setVersion_enum is by default set to the first enum value, so not setting it here
24  this->verId_db[id].set_version_value(version_string);
25  this->verId_db[id].set_version_status(VersionStatus::FAILURE);
26  }
27 }
28 
30 
31 void Version::config(bool enable) {
32  // Set Verbosity for custom versions
33  this->m_enable = enable;
34 }
35 
37  // Send startup TLM and EVENTS
38  this->fwVersion_tlm();
39  this->projectVersion_tlm();
40  this->libraryVersion_tlm();
41 }
42 // ----------------------------------------------------------------------
43 // Handler implementations for user-defined typed input ports
44 // ----------------------------------------------------------------------
45 
46 void Version ::getVersion_handler(FwIndexType portNum,
47  const Svc::VersionCfg::VersionEnum& version_id,
48  Fw::StringBase& version_string,
49  Svc::VersionStatus& status) {
50  FW_ASSERT(version_id.isValid(), version_id.e);
51  FW_ASSERT(static_cast<Svc::VersionCfg::VersionEnum::SerialType>(version_id.e) <
53  version_id.e);
54  U8 version_slot = VersionSlot(version_id.e);
55  version_string = static_cast<const Fw::StringBase&>(this->verId_db[version_slot].get_version_value());
56  status = this->verId_db[version_slot].get_version_status();
57 }
58 
59 void Version ::setVersion_handler(FwIndexType portNum,
60  const Svc::VersionCfg::VersionEnum& version_id,
61  Fw::StringBase& version_string,
62  Svc::VersionStatus& status) {
63  FW_ASSERT(version_id.isValid(), version_id.e);
64  FW_ASSERT(static_cast<Svc::VersionCfg::VersionEnum::SerialType>(version_id.e) <
66  version_id.e);
67  auto ver_slot = VersionSlot(version_id.e);
68  // Count each slot once: rewrites of a populated slot must not grow the count
69  if ((this->verId_db[ver_slot].get_version_value() == "no_ver") &&
70  (this->m_num_custom_elements < Svc::VersionCfg::VersionEnum::NUM_CONSTANTS)) {
71  this->m_num_custom_elements++;
72  }
73  this->verId_db[ver_slot].set_version_enum(version_id);
74  this->verId_db[ver_slot].set_version_value(version_string);
75  this->verId_db[ver_slot].set_version_status(status);
76  this->customVersion_tlm(ver_slot);
77 }
78 
79 // Scheduled handler to periodically re-emit all version information (without event spamming)
80 void Version ::schedIn_handler(FwIndexType portNum, U32 context) {
81  this->projectVersion_tlm(/* sendEvent = */ false);
82  this->fwVersion_tlm(/* sendEvent = */ false);
83  this->libraryVersion_tlm(/* sendEvent = */ false);
84  this->customVersion_tlm_all(/* sendEvent = */ false);
85 }
86 
87 // ----------------------------------------------------------------------
88 // Handler implementations for commands
89 // ----------------------------------------------------------------------
90 
91 void Version ::ENABLE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Svc::VersionEnabled& enable) {
92  this->m_enable = (enable == VersionEnabled::ENABLED);
93 
94  this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
95 }
96 
97 // Command handler to event versions
98 void Version ::VERSION_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Svc::VersionType& version_type) {
99  FW_ASSERT(version_type.isValid(), version_type.e);
100 
101  switch (version_type) {
103  this->projectVersion_tlm();
104  break;
105 
107  this->fwVersion_tlm();
108  break;
109 
111  this->libraryVersion_tlm();
112  break;
113 
115  this->customVersion_tlm_all();
116  break;
117 
118  case (Svc::VersionType::ALL):
119  this->projectVersion_tlm();
120  this->fwVersion_tlm();
121  this->libraryVersion_tlm();
122  this->customVersion_tlm_all();
123  break;
124  default:
125  FW_ASSERT(false, version_type);
126  break;
127  }
128 
129  this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
130 }
131 // ----------------------------------------------------------------------
132 // implementations for internal functions
133 // ----------------------------------------------------------------------
134 // Write framework version tlm; also emit the event when sendEvent is true (default in Version.hpp)
135 void Version ::fwVersion_tlm(bool sendEvent) {
136  if (sendEvent) {
138  this->log_ACTIVITY_LO_FrameworkVersion(fw_event);
139  }
141  this->tlmWrite_FrameworkVersion(fw_tlm);
142 }
143 // Write project version tlm; also emit the event when sendEvent is true (default in Version.hpp)
144 void Version ::projectVersion_tlm(bool sendEvent) {
145  if (sendEvent) {
147  this->log_ACTIVITY_LO_ProjectVersion(proj_event);
148  }
150  this->tlmWrite_ProjectVersion(proj_tlm);
151 }
152 // Write library version tlm; also emit the event when sendEvent is true (default in Version.hpp)
153 void Version ::libraryVersion_tlm(bool sendEvent) {
154  // Process libraries array
156  FW_ASSERT(Project::Version::LIBRARY_VERSIONS[i] != nullptr, static_cast<FwAssertArgType>(i));
157  // Write to Events, if enabled via sendEvent function argument
158  if (sendEvent) {
160  }
161 
162  // Emit TLM on library versions
163  switch (i) {
164  case VER_SLOT_00:
166  break;
167  case VER_SLOT_01:
169  break;
170  case VER_SLOT_02:
172  break;
173  case VER_SLOT_03:
175  break;
176  case VER_SLOT_04:
178  break;
179  case VER_SLOT_05:
181  break;
182  case VER_SLOT_06:
184  break;
185  case VER_SLOT_07:
187  break;
188  case VER_SLOT_08:
190  break;
191  case VER_SLOT_09:
193  break;
194  default:
195  // It is possible to have more than 10 library versions; however design agreed to only
196  // provide 10 TLM channels for it
197  break;
198  }
199  }
200 }
201 // Write all custom version tlm; also emit the event when sendEvent is true (default in Version.hpp)
202 void Version ::customVersion_tlm_all(bool sendEvent) {
203  // projects may define a maximum of 32 custom slots
204  static_assert(Svc::VersionCfg::VersionEnum::NUM_CONSTANTS <= VER_SLOT_31 + 1,
205  "Svc::Version supports at most 32 custom version slots");
206  for (U8 i = 0; (m_num_custom_elements != 0) && (i < Svc::VersionCfg::VersionEnum::NUM_CONSTANTS); i++) {
207  this->customVersion_tlm(static_cast<VersionSlot>(i), sendEvent);
208  }
209 }
210 // Write custom version tlm; also emit the event when sendEvent is true (default in Version.hpp)
211 void Version ::customVersion_tlm(VersionSlot custom_slot, bool sendEvent) {
212  // Process custom version TLM only if verbosity is enabled and there are any valid writes to it;
213  // it doesn't necessarily have to be consecutive
214  if ((this->verId_db[custom_slot].get_version_value() != "no_ver") &&
215  (this->m_num_custom_elements > 0)) { // Write TLM for valid writes
216 
217  // Write to Events, if enabled via sendEvent function argument
218  if (sendEvent) {
219  this->log_ACTIVITY_LO_CustomVersions(this->verId_db[custom_slot].get_version_enum(),
220  this->verId_db[custom_slot].get_version_value());
221  }
222 
223  if (m_enable == true) { // Send TLM only if verbosity is enabled
224  // Write to TLM
225  switch (custom_slot) {
226  case VER_SLOT_00:
227  this->tlmWrite_CustomVersion01(verId_db[custom_slot]);
228  break;
229  case VER_SLOT_01:
230  this->tlmWrite_CustomVersion02(verId_db[custom_slot]);
231  break;
232  case VER_SLOT_02:
233  this->tlmWrite_CustomVersion03(verId_db[custom_slot]);
234  break;
235  case VER_SLOT_03:
236  this->tlmWrite_CustomVersion04(verId_db[custom_slot]);
237  break;
238  case VER_SLOT_04:
239  this->tlmWrite_CustomVersion05(verId_db[custom_slot]);
240  break;
241  case VER_SLOT_05:
242  this->tlmWrite_CustomVersion06(verId_db[custom_slot]);
243  break;
244  case VER_SLOT_06:
245  this->tlmWrite_CustomVersion07(verId_db[custom_slot]);
246  break;
247  case VER_SLOT_07:
248  this->tlmWrite_CustomVersion08(verId_db[custom_slot]);
249  break;
250  case VER_SLOT_08:
251  this->tlmWrite_CustomVersion09(verId_db[custom_slot]);
252  break;
253  case VER_SLOT_09:
254  this->tlmWrite_CustomVersion10(verId_db[custom_slot]);
255  break;
256  case VER_SLOT_10:
257  this->tlmWrite_CustomVersion11(verId_db[custom_slot]);
258  break;
259  case VER_SLOT_11:
260  this->tlmWrite_CustomVersion12(verId_db[custom_slot]);
261  break;
262  case VER_SLOT_12:
263  this->tlmWrite_CustomVersion13(verId_db[custom_slot]);
264  break;
265  case VER_SLOT_13:
266  this->tlmWrite_CustomVersion14(verId_db[custom_slot]);
267  break;
268  case VER_SLOT_14:
269  this->tlmWrite_CustomVersion15(verId_db[custom_slot]);
270  break;
271  case VER_SLOT_15:
272  this->tlmWrite_CustomVersion16(verId_db[custom_slot]);
273  break;
274  case VER_SLOT_16:
275  this->tlmWrite_CustomVersion17(verId_db[custom_slot]);
276  break;
277  case VER_SLOT_17:
278  this->tlmWrite_CustomVersion18(verId_db[custom_slot]);
279  break;
280  case VER_SLOT_18:
281  this->tlmWrite_CustomVersion19(verId_db[custom_slot]);
282  break;
283  case VER_SLOT_19:
284  this->tlmWrite_CustomVersion20(verId_db[custom_slot]);
285  break;
286  case VER_SLOT_20:
287  this->tlmWrite_CustomVersion21(verId_db[custom_slot]);
288  break;
289  case VER_SLOT_21:
290  this->tlmWrite_CustomVersion22(verId_db[custom_slot]);
291  break;
292  case VER_SLOT_22:
293  this->tlmWrite_CustomVersion23(verId_db[custom_slot]);
294  break;
295  case VER_SLOT_23:
296  this->tlmWrite_CustomVersion24(verId_db[custom_slot]);
297  break;
298  case VER_SLOT_24:
299  this->tlmWrite_CustomVersion25(verId_db[custom_slot]);
300  break;
301  case VER_SLOT_25:
302  this->tlmWrite_CustomVersion26(verId_db[custom_slot]);
303  break;
304  case VER_SLOT_26:
305  this->tlmWrite_CustomVersion27(verId_db[custom_slot]);
306  break;
307  case VER_SLOT_27:
308  this->tlmWrite_CustomVersion28(verId_db[custom_slot]);
309  break;
310  case VER_SLOT_28:
311  this->tlmWrite_CustomVersion29(verId_db[custom_slot]);
312  break;
313  case VER_SLOT_29:
314  this->tlmWrite_CustomVersion30(verId_db[custom_slot]);
315  break;
316  case VER_SLOT_30:
317  this->tlmWrite_CustomVersion31(verId_db[custom_slot]);
318  break;
319  case VER_SLOT_31:
320  this->tlmWrite_CustomVersion32(verId_db[custom_slot]);
321  break;
322  default:
323  // There are only 32 custom slots available
324  FW_ASSERT(false, custom_slot);
325  break;
326  }
327  }
328  }
329 }
330 
331 } // namespace Svc
static const char *const LIBRARY_VERSIONS[]
Definition: version.hpp:15
void tlmWrite_LibraryVersion10(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion10.
void tlmWrite_CustomVersion07(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion07.
void set_version_value(const Fw::StringBase &version_value)
Set member version_value.
void tlmWrite_CustomVersion28(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion28.
void tlmWrite_LibraryVersion04(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion04.
void tlmWrite_CustomVersion32(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion32.
FwIdType FwOpcodeType
The type of a command opcode.
void tlmWrite_LibraryVersion01(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
static const char *const PROJECT_VERSION
Definition: version.hpp:13
void set_version_status(Svc::VersionStatus::T version_status)
Set member version_status.
void tlmWrite_CustomVersion02(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion02.
all above versions
void tlmWrite_CustomVersion10(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion10.
void tlmWrite_LibraryVersion06(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion06.
enum T e
The raw enum value.
void tlmWrite_CustomVersion03(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion03.
void start()
send initial version tlm and events
Definition: Version.cpp:36
void tlmWrite_CustomVersion11(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion11.
Svc::VersionStatus::T get_version_status() const
Get member version_status.
void tlmWrite_LibraryVersion03(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion03.
void tlmWrite_CustomVersion15(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion15.
static const FwIndexType LIBRARY_VERSIONS_COUNT
Definition: version.hpp:14
void tlmWrite_CustomVersion30(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion30.
void cmdResponse_out(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
Emit command response.
enum T e
The raw enum value.
void tlmWrite_LibraryVersion08(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion08.
void tlmWrite_CustomVersion12(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion12.
Failure to get version.
void tlmWrite_CustomVersion13(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion13.
void tlmWrite_CustomVersion05(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion05.
void tlmWrite_CustomVersion21(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion21.
Auto-generated base for Version component.
void log_ACTIVITY_LO_ProjectVersion(const Fw::StringBase &version) const
static const char *const FRAMEWORK_VERSION
Definition: version.hpp:12
An enumeration for version status.
void tlmWrite_CustomVersion19(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion19.
void set_version_enum(Svc::VersionCfg::VersionEnum::T version_enum)
Set member version_enum.
void tlmWrite_CustomVersion31(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion31.
void tlmWrite_CustomVersion20(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion20.
void tlmWrite_LibraryVersion05(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion05.
Fw::ExternalString & get_version_value()
Get member version_value.
void tlmWrite_CustomVersion25(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion25.
Command successfully executed.
void tlmWrite_CustomVersion27(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion27.
void log_ACTIVITY_LO_CustomVersions(const Svc::VersionCfg::VersionEnum &version_enum, const Fw::StringBase &version_value) const
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:54
void tlmWrite_CustomVersion24(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion24.
void tlmWrite_CustomVersion26(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion26.
void tlmWrite_CustomVersion14(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion14.
The number of enumerated constants.
Version(const char *const compName)
Construct Version object.
Definition: Version.cpp:18
void config(bool enable)
configure version&#39;s verbosity
Definition: Version.cpp:31
void tlmWrite_CustomVersion23(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion23.
void tlmWrite_CustomVersion17(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion17.
void tlmWrite_CustomVersion09(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion09.
PlatformIndexType FwIndexType
void tlmWrite_CustomVersion06(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion06.
void tlmWrite_LibraryVersion07(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion07.
bool isValid() const
Check raw enum value for validity.
~Version()
Destroy Version object.
Definition: Version.cpp:29
void tlmWrite_CustomVersion18(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion18.
RateGroupDivider component implementation.
An enumeration for Version Type.
void tlmWrite_LibraryVersion02(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion02.
void tlmWrite_CustomVersion04(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion04.
void tlmWrite_CustomVersion16(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion16.
void tlmWrite_CustomVersion22(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion22.
void tlmWrite_CustomVersion01(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
void tlmWrite_CustomVersion29(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion29.
void log_ACTIVITY_LO_FrameworkVersion(const Fw::StringBase &version) const
void log_ACTIVITY_LO_LibraryVersions(const Fw::StringBase &version) const
Tracks versions for project, framework and user defined versions etc.
#define FW_ASSERT(...)
Definition: Assert.hpp:14
bool isValid() const
Check raw enum value for validity.
void tlmWrite_CustomVersion08(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion08.
void tlmWrite_LibraryVersion09(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion09.
void tlmWrite_FrameworkVersion(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
void tlmWrite_ProjectVersion(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const