F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
VersionComponentAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title VersionComponentAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for Version component base class
5 // ======================================================================
6 
7 #ifndef Svc_VersionComponentAc_HPP
8 #define Svc_VersionComponentAc_HPP
9 
10 #include <atomic>
11 
12 #include "Fw/Cmd/CmdPortAc.hpp"
13 #include "Fw/Cmd/CmdRegPortAc.hpp"
15 #include "Fw/Cmd/CmdString.hpp"
17 #include "Fw/FPrimeBasicTypes.hpp"
18 #include "Fw/Log/LogPortAc.hpp"
19 #include "Fw/Log/LogString.hpp"
20 #include "Fw/Log/LogTextPortAc.hpp"
21 #if !FW_DIRECT_PORT_CALLS
23 #endif
24 #if !FW_DIRECT_PORT_CALLS
26 #endif
27 #include "Fw/Time/TimePortAc.hpp"
28 #include "Fw/Tlm/TlmPortAc.hpp"
29 #include "Fw/Tlm/TlmString.hpp"
30 #include "Os/Mutex.hpp"
38 
39 namespace Svc {
40 
45  {
46 
47  // ----------------------------------------------------------------------
48  // Friend classes
49  // ----------------------------------------------------------------------
50 
52  friend class VersionTesterBase;
54  friend class VersionTester;
55 
56  protected:
57 
58  // ----------------------------------------------------------------------
59  // Constants
60  // ----------------------------------------------------------------------
61 
63  enum {
65  };
66 
68  enum {
72  };
73 
75  enum {
82  };
83 
85  enum {
86  OPCODE_ENABLE = 0x0,
88  };
89 
91  enum {
96  };
97 
99  enum {
144  };
145 
146  public:
147 
148  // ----------------------------------------------------------------------
149  // Component initialization
150  // ----------------------------------------------------------------------
151 
153  void init(
154  FwEnumStoreType instance = 0
155  );
156 
157 #if !FW_DIRECT_PORT_CALLS
158 
159  public:
160 
161  // ----------------------------------------------------------------------
162  // Getters for special input ports
163  // ----------------------------------------------------------------------
164 
169  FwIndexType portNum
170  );
171 
172 #endif
173 
174 #if !FW_DIRECT_PORT_CALLS
175 
176  public:
177 
178  // ----------------------------------------------------------------------
179  // Getters for typed input ports
180  // ----------------------------------------------------------------------
181 
186  FwIndexType portNum
187  );
188 
193  FwIndexType portNum
194  );
195 
200  FwIndexType portNum
201  );
202 
203 #endif
204 
205 #if !FW_DIRECT_PORT_CALLS
206 
207  public:
208 
209  // ----------------------------------------------------------------------
210  // Connect input ports to special output ports
211  // ----------------------------------------------------------------------
212 
215  FwIndexType portNum,
216  Fw::InputCmdRegPort* port
217  );
218 
221  FwIndexType portNum,
223  );
224 
227  FwIndexType portNum,
228  Fw::InputLogPort* port
229  );
230 
231 #if FW_ENABLE_TEXT_LOGGING == 1
232 
234  void set_logTextOut_OutputPort(
235  FwIndexType portNum,
236  Fw::InputLogTextPort* port
237  );
238 
239 #endif
240 
243  FwIndexType portNum,
244  Fw::InputTimePort* port
245  );
246 
249  FwIndexType portNum,
250  Fw::InputTlmPort* port
251  );
252 
253 #endif
254 
255 #if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION
256 
257  public:
258 
259  // ----------------------------------------------------------------------
260  // Connect serial input ports to special output ports
261  // ----------------------------------------------------------------------
262 
265  FwIndexType portNum,
266  Fw::InputSerializePort* port
267  );
268 
271  FwIndexType portNum,
272  Fw::InputSerializePort* port
273  );
274 
277  FwIndexType portNum,
278  Fw::InputSerializePort* port
279  );
280 
281 #if FW_ENABLE_TEXT_LOGGING == 1
282 
284  void set_logTextOut_OutputPort(
285  FwIndexType portNum,
286  Fw::InputSerializePort* port
287  );
288 
289 #endif
290 
293  FwIndexType portNum,
294  Fw::InputSerializePort* port
295  );
296 
299  FwIndexType portNum,
300  Fw::InputSerializePort* port
301  );
302 
303 #endif
304 
305  public:
306 
307  // ----------------------------------------------------------------------
308  // Command registration
309  // ----------------------------------------------------------------------
310 
314  void regCommands();
315 
316  protected:
317 
318  // ----------------------------------------------------------------------
319  // Component construction and destruction
320  // ----------------------------------------------------------------------
321 
324  const char* compName = ""
325  );
326 
328  virtual ~VersionComponentBase();
329 
330  protected:
331 
332  // ----------------------------------------------------------------------
333  // Getters for numbers of special input ports
334  // ----------------------------------------------------------------------
335 
340  return NUM_CMDIN_INPUT_PORTS;
341  }
342 
343  protected:
344 
345  // ----------------------------------------------------------------------
346  // Getters for numbers of typed input ports
347  // ----------------------------------------------------------------------
348 
354  }
355 
361  }
362 
368  }
369 
370  protected:
371 
372  // ----------------------------------------------------------------------
373  // Getters for numbers of special output ports
374  // ----------------------------------------------------------------------
375 
381  }
382 
388  }
389 
395  }
396 
397 #if FW_ENABLE_TEXT_LOGGING == 1
398 
402  static constexpr FwIndexType getNum_logTextOut_OutputPorts() {
404  }
405 
406 #endif
407 
413  }
414 
420  }
421 
422  protected:
423 
424  // ----------------------------------------------------------------------
425  // Connection status queries for special output ports
426  // ----------------------------------------------------------------------
427 
432  FwIndexType portNum
433  ) const;
434 
439  FwIndexType portNum
440  ) const;
441 
446  FwIndexType portNum
447  ) const;
448 
449 #if FW_ENABLE_TEXT_LOGGING == 1
450 
454  bool isConnected_logTextOut_OutputPort(
455  FwIndexType portNum
456  ) const;
457 
458 #endif
459 
464  FwIndexType portNum
465  ) const;
466 
471  FwIndexType portNum
472  ) const;
473 
474 #if FW_DIRECT_PORT_CALLS
475  public:
476 #else
477  protected:
478 #endif
479 
480  // ----------------------------------------------------------------------
481  // Port handler base-class functions for special input ports
482  //
483  // Call these functions directly to bypass the corresponding ports
484  // ----------------------------------------------------------------------
485 
487  void cmdIn_handlerBase(
488  FwIndexType portNum,
489  FwOpcodeType opCode,
490  U32 cmdSeq,
491  Fw::CmdArgBuffer& args
492  );
493 
494  protected:
495 
496  // ----------------------------------------------------------------------
497  // Handlers to implement for typed input ports
498  // ----------------------------------------------------------------------
499 
501  virtual void getVersion_handler(
502  FwIndexType portNum,
503  const Svc::VersionCfg::VersionEnum& version_id,
504  Fw::StringBase& version_string,
505  Svc::VersionStatus& status
506  ) = 0;
507 
509  virtual void schedIn_handler(
510  FwIndexType portNum,
511  U32 context
512  ) = 0;
513 
515  virtual void setVersion_handler(
516  FwIndexType portNum,
517  const Svc::VersionCfg::VersionEnum& version_id,
518  Fw::StringBase& version_string,
519  Svc::VersionStatus& status
520  ) = 0;
521 
522 #if FW_DIRECT_PORT_CALLS
523  public:
524 #else
525  protected:
526 #endif
527 
528  // ----------------------------------------------------------------------
529  // Port handler base-class functions for typed input ports
530  //
531  // Call these functions directly to bypass the corresponding ports
532  // ----------------------------------------------------------------------
533 
536  FwIndexType portNum,
537  const Svc::VersionCfg::VersionEnum& version_id,
538  Fw::StringBase& version_string,
539  Svc::VersionStatus& status
540  );
541 
543  void schedIn_handlerBase(
544  FwIndexType portNum,
545  U32 context
546  );
547 
550  FwIndexType portNum,
551  const Svc::VersionCfg::VersionEnum& version_id,
552  Fw::StringBase& version_string,
553  Svc::VersionStatus& status
554  );
555 
556  protected:
557 
558  // ----------------------------------------------------------------------
559  // Command response
560  // ----------------------------------------------------------------------
561 
563  void cmdResponse_out(
564  FwOpcodeType opCode,
565  U32 cmdSeq,
566  Fw::CmdResponse response
567  );
568 
569  protected:
570 
571  // ----------------------------------------------------------------------
572  // Command handlers to implement
573  // ----------------------------------------------------------------------
574 
578  virtual void ENABLE_cmdHandler(
579  FwOpcodeType opCode,
580  U32 cmdSeq,
581  const Svc::VersionEnabled& enable
582  ) = 0;
583 
587  virtual void VERSION_cmdHandler(
588  FwOpcodeType opCode,
589  U32 cmdSeq,
590  const Svc::VersionType& version_type
591  ) = 0;
592 
593  protected:
594 
595  // ----------------------------------------------------------------------
596  // Command handler base-class functions
597  //
598  // Call these functions directly to bypass the command input port
599  // ----------------------------------------------------------------------
600 
605  FwOpcodeType opCode,
606  U32 cmdSeq,
607  Fw::CmdArgBuffer& args
608  );
609 
614  FwOpcodeType opCode,
615  U32 cmdSeq,
616  Fw::CmdArgBuffer& args
617  );
618 
619  protected:
620 
621  // ----------------------------------------------------------------------
622  // Event logging functions
623  // ----------------------------------------------------------------------
624 
629  const Fw::StringBase& version
630  ) const;
631 
636  const Fw::StringBase& version
637  ) const;
638 
643  const Fw::StringBase& version
644  ) const;
645 
650  const Svc::VersionCfg::VersionEnum& version_enum,
651  const Fw::StringBase& version_value
652  ) const;
653 
654  protected:
655 
656  // ----------------------------------------------------------------------
657  // Telemetry serialized write
658  // ----------------------------------------------------------------------
659 
664  void tlmWrite(
665  FwChanIdType id,
666  Fw::TlmBuffer& _tlmBuff,
667  Fw::Time _tlmTime = Fw::Time()
668  ) const;
669 
670  protected:
671 
672  // ----------------------------------------------------------------------
673  // Telemetry write functions
674  // ----------------------------------------------------------------------
675 
680  const Fw::StringBase& arg,
681  Fw::Time _tlmTime = Fw::Time()
682  ) const;
683 
688  const Fw::StringBase& arg,
689  Fw::Time _tlmTime = Fw::Time()
690  ) const;
691 
696  const Svc::CustomVersionDb& arg,
697  Fw::Time _tlmTime = Fw::Time()
698  ) const;
699 
702  const Svc::CustomVersionDb& arg,
703  Fw::Time _tlmTime = Fw::Time()
704  ) const;
705 
708  const Svc::CustomVersionDb& arg,
709  Fw::Time _tlmTime = Fw::Time()
710  ) const;
711 
714  const Svc::CustomVersionDb& arg,
715  Fw::Time _tlmTime = Fw::Time()
716  ) const;
717 
720  const Svc::CustomVersionDb& arg,
721  Fw::Time _tlmTime = Fw::Time()
722  ) const;
723 
726  const Svc::CustomVersionDb& arg,
727  Fw::Time _tlmTime = Fw::Time()
728  ) const;
729 
732  const Svc::CustomVersionDb& arg,
733  Fw::Time _tlmTime = Fw::Time()
734  ) const;
735 
738  const Svc::CustomVersionDb& arg,
739  Fw::Time _tlmTime = Fw::Time()
740  ) const;
741 
744  const Svc::CustomVersionDb& arg,
745  Fw::Time _tlmTime = Fw::Time()
746  ) const;
747 
750  const Svc::CustomVersionDb& arg,
751  Fw::Time _tlmTime = Fw::Time()
752  ) const;
753 
758  const Fw::StringBase& arg,
759  Fw::Time _tlmTime = Fw::Time()
760  ) const;
761 
764  const Fw::StringBase& arg,
765  Fw::Time _tlmTime = Fw::Time()
766  ) const;
767 
770  const Fw::StringBase& arg,
771  Fw::Time _tlmTime = Fw::Time()
772  ) const;
773 
776  const Fw::StringBase& arg,
777  Fw::Time _tlmTime = Fw::Time()
778  ) const;
779 
782  const Fw::StringBase& arg,
783  Fw::Time _tlmTime = Fw::Time()
784  ) const;
785 
788  const Fw::StringBase& arg,
789  Fw::Time _tlmTime = Fw::Time()
790  ) const;
791 
794  const Fw::StringBase& arg,
795  Fw::Time _tlmTime = Fw::Time()
796  ) const;
797 
800  const Fw::StringBase& arg,
801  Fw::Time _tlmTime = Fw::Time()
802  ) const;
803 
806  const Fw::StringBase& arg,
807  Fw::Time _tlmTime = Fw::Time()
808  ) const;
809 
812  const Fw::StringBase& arg,
813  Fw::Time _tlmTime = Fw::Time()
814  ) const;
815 
818  const Svc::CustomVersionDb& arg,
819  Fw::Time _tlmTime = Fw::Time()
820  ) const;
821 
824  const Svc::CustomVersionDb& arg,
825  Fw::Time _tlmTime = Fw::Time()
826  ) const;
827 
830  const Svc::CustomVersionDb& arg,
831  Fw::Time _tlmTime = Fw::Time()
832  ) const;
833 
836  const Svc::CustomVersionDb& arg,
837  Fw::Time _tlmTime = Fw::Time()
838  ) const;
839 
842  const Svc::CustomVersionDb& arg,
843  Fw::Time _tlmTime = Fw::Time()
844  ) const;
845 
848  const Svc::CustomVersionDb& arg,
849  Fw::Time _tlmTime = Fw::Time()
850  ) const;
851 
854  const Svc::CustomVersionDb& arg,
855  Fw::Time _tlmTime = Fw::Time()
856  ) const;
857 
860  const Svc::CustomVersionDb& arg,
861  Fw::Time _tlmTime = Fw::Time()
862  ) const;
863 
866  const Svc::CustomVersionDb& arg,
867  Fw::Time _tlmTime = Fw::Time()
868  ) const;
869 
872  const Svc::CustomVersionDb& arg,
873  Fw::Time _tlmTime = Fw::Time()
874  ) const;
875 
878  const Svc::CustomVersionDb& arg,
879  Fw::Time _tlmTime = Fw::Time()
880  ) const;
881 
884  const Svc::CustomVersionDb& arg,
885  Fw::Time _tlmTime = Fw::Time()
886  ) const;
887 
890  const Svc::CustomVersionDb& arg,
891  Fw::Time _tlmTime = Fw::Time()
892  ) const;
893 
896  const Svc::CustomVersionDb& arg,
897  Fw::Time _tlmTime = Fw::Time()
898  ) const;
899 
902  const Svc::CustomVersionDb& arg,
903  Fw::Time _tlmTime = Fw::Time()
904  ) const;
905 
908  const Svc::CustomVersionDb& arg,
909  Fw::Time _tlmTime = Fw::Time()
910  ) const;
911 
914  const Svc::CustomVersionDb& arg,
915  Fw::Time _tlmTime = Fw::Time()
916  ) const;
917 
920  const Svc::CustomVersionDb& arg,
921  Fw::Time _tlmTime = Fw::Time()
922  ) const;
923 
926  const Svc::CustomVersionDb& arg,
927  Fw::Time _tlmTime = Fw::Time()
928  ) const;
929 
932  const Svc::CustomVersionDb& arg,
933  Fw::Time _tlmTime = Fw::Time()
934  ) const;
935 
938  const Svc::CustomVersionDb& arg,
939  Fw::Time _tlmTime = Fw::Time()
940  ) const;
941 
944  const Svc::CustomVersionDb& arg,
945  Fw::Time _tlmTime = Fw::Time()
946  ) const;
947 
948  protected:
949 
950  // ----------------------------------------------------------------------
951  // Time
952  // ----------------------------------------------------------------------
953 
957  Fw::Time getTime() const;
958 
959  protected:
960 
961  // ----------------------------------------------------------------------
962  // Mutex operations for guarded ports
963  //
964  // You can override these operations to provide more sophisticated
965  // synchronization
966  // ----------------------------------------------------------------------
967 
969  virtual void lock();
970 
972  virtual void unLock();
973 
974  private:
975 
976  // ----------------------------------------------------------------------
977  // Calls for messages received on special input ports
978  // ----------------------------------------------------------------------
979 
981  static void m_p_cmdIn_in(
982  Fw::PassiveComponentBase* callComp,
983  FwIndexType portNum,
984  FwOpcodeType opCode,
985  U32 cmdSeq,
986  Fw::CmdArgBuffer& args
987  );
988 
989  private:
990 
991  // ----------------------------------------------------------------------
992  // Calls for messages received on typed input ports
993  // ----------------------------------------------------------------------
994 
996  static void m_p_getVersion_in(
997  Fw::PassiveComponentBase* callComp,
998  FwIndexType portNum,
999  const Svc::VersionCfg::VersionEnum& version_id,
1000  Fw::StringBase& version_string,
1001  Svc::VersionStatus& status
1002  );
1003 
1005  static void m_p_schedIn_in(
1006  Fw::PassiveComponentBase* callComp,
1007  FwIndexType portNum,
1008  U32 context
1009  );
1010 
1012  static void m_p_setVersion_in(
1013  Fw::PassiveComponentBase* callComp,
1014  FwIndexType portNum,
1015  const Svc::VersionCfg::VersionEnum& version_id,
1016  Fw::StringBase& version_string,
1017  Svc::VersionStatus& status
1018  );
1019 
1020  private:
1021 
1022  // ----------------------------------------------------------------------
1023  // Invocation functions for special output ports
1024  // ----------------------------------------------------------------------
1025 
1027  void cmdRegOut_out(
1028  FwIndexType portNum,
1029  FwOpcodeType opCode
1030  ) const;
1031 
1033  void cmdResponseOut_out(
1034  FwIndexType portNum,
1035  FwOpcodeType opCode,
1036  U32 cmdSeq,
1037  const Fw::CmdResponse& response
1038  ) const;
1039 
1041  void logOut_out(
1042  FwIndexType portNum,
1043  FwEventIdType id,
1044  Fw::Time& timeTag,
1045  const Fw::LogSeverity& severity,
1046  Fw::LogBuffer& args
1047  ) const;
1048 
1049 #if FW_ENABLE_TEXT_LOGGING
1050 
1052  void logTextOut_out(
1053  FwIndexType portNum,
1054  FwEventIdType id,
1055  Fw::Time& timeTag,
1056  const Fw::LogSeverity& severity,
1057  Fw::TextLogString& text
1058  ) const;
1059 
1060 #endif
1061 
1063  void timeCaller_out(
1064  FwIndexType portNum,
1065  Fw::Time& time
1066  ) const;
1067 
1069  void tlmOut_out(
1070  FwIndexType portNum,
1071  FwChanIdType id,
1072  Fw::Time& timeTag,
1073  Fw::TlmBuffer& val
1074  ) const;
1075 
1076 #if !FW_DIRECT_PORT_CALLS
1077 
1078  private:
1079 
1080  // ----------------------------------------------------------------------
1081  // Special input ports
1082  // ----------------------------------------------------------------------
1083 
1085  Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];
1086 
1087 #endif
1088 
1089 #if !FW_DIRECT_PORT_CALLS
1090 
1091  private:
1092 
1093  // ----------------------------------------------------------------------
1094  // Typed input ports
1095  // ----------------------------------------------------------------------
1096 
1098  Svc::InputVersionPort m_getVersion_InputPort[NUM_GETVERSION_INPUT_PORTS];
1099 
1101  Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
1102 
1104  Svc::InputVersionPort m_setVersion_InputPort[NUM_SETVERSION_INPUT_PORTS];
1105 
1106 #endif
1107 
1108 #if !FW_DIRECT_PORT_CALLS
1109 
1110  private:
1111 
1112  // ----------------------------------------------------------------------
1113  // Special output ports
1114  // ----------------------------------------------------------------------
1115 
1117  Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];
1118 
1120  Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];
1121 
1123  Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];
1124 
1125 #if FW_ENABLE_TEXT_LOGGING == 1
1126 
1128  Fw::OutputLogTextPort m_logTextOut_OutputPort[NUM_LOGTEXTOUT_OUTPUT_PORTS];
1129 
1130 #endif
1131 
1133  Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
1134 
1136  Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
1137 
1138 #endif
1139 
1140  private:
1141 
1142  // ----------------------------------------------------------------------
1143  // Mutexes
1144  // ----------------------------------------------------------------------
1145 
1147  Os::Mutex m_guardedPortMutex;
1148 
1149  };
1150 
1151 }
1152 
1153 #endif
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 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 regCommands()
Register commands with the Command Dispatcher.
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(FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const
void tlmWrite_LibraryVersion01(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
virtual void getVersion_handler(FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)=0
Handler for input port getVersion.
static constexpr FwIndexType getNum_cmdRegOut_OutputPorts()
void tlmWrite_CustomVersion02(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion02.
I32 FwEnumStoreType
bool isConnected_tlmOut_OutputPort(FwIndexType portNum) const
void tlmWrite_CustomVersion10(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion10.
virtual void ENABLE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Svc::VersionEnabled &enable)=0
void set_tlmOut_OutputPort(FwIndexType portNum, Fw::InputTlmPort *port)
Connect port to tlmOut[portNum].
void set_logOut_OutputPort(FwIndexType portNum, Fw::InputLogPort *port)
Connect port to logOut[portNum].
void tlmWrite_LibraryVersion06(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion06.
static constexpr FwIndexType getNum_cmdIn_InputPorts()
virtual void setVersion_handler(FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)=0
Handler for input port setVersion.
bool isConnected_cmdRegOut_OutputPort(FwIndexType portNum) const
Fw::InputCmdPort * get_cmdIn_InputPort(FwIndexType portNum)
void tlmWrite_CustomVersion03(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion03.
Link-time delegating Mutex implementation.
A command to enable or disable Event verbosity and Telemetry.
void tlmWrite_CustomVersion11(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion11.
void VERSION_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void unLock()
Unlock the guarded mutex.
friend class VersionTesterBase
Friend class tester to support autocoded test harness.
void tlmWrite_LibraryVersion03(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion03.
Enum representing a command response.
void tlmWrite_CustomVersion15(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion15.
static constexpr FwIndexType getNum_getVersion_InputPorts()
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.
static constexpr FwIndexType getNum_tlmOut_OutputPorts()
void tlmWrite_LibraryVersion08(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion08.
void init()
Object initializer.
Definition: ObjBase.cpp:24
virtual ~VersionComponentBase()
Destroy VersionComponentBase object.
void tlmWrite_CustomVersion12(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion12.
void tlmWrite_CustomVersion13(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion13.
void setVersion_handlerBase(FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)
Handler base-class function for input port setVersion.
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.
FwIdType FwEventIdType
The type of an event identifier.
Auto-generated base for Version component.
void log_ACTIVITY_LO_ProjectVersion(const Fw::StringBase &version) const
An enumeration for version status.
void tlmWrite_CustomVersion19(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion19.
Svc::InputVersionPort * get_getVersion_InputPort(FwIndexType portNum)
static constexpr FwIndexType getNum_timeCaller_OutputPorts()
friend class VersionTester
Friend class tester implementation to support white-box testing.
void schedIn_handlerBase(FwIndexType portNum, U32 context)
Handler base-class function for input port schedIn.
void tlmWrite_CustomVersion31(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion31.
virtual void schedIn_handler(FwIndexType portNum, U32 context)=0
Handler for input port schedIn.
void tlmWrite_CustomVersion20(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion20.
FwIdType FwChanIdType
The type of a telemetry channel identifier.
void tlmWrite_LibraryVersion05(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion05.
Svc::InputVersionPort * get_setVersion_InputPort(FwIndexType portNum)
void getVersion_handlerBase(FwIndexType portNum, const Svc::VersionCfg::VersionEnum &version_id, Fw::StringBase &version_string, Svc::VersionStatus &status)
Handler base-class function for input port getVersion.
Enum representing event severity.
void tlmWrite_CustomVersion25(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion25.
Data Structure for custom version Tlm.
void set_cmdResponseOut_OutputPort(FwIndexType portNum, Fw::InputCmdResponsePort *port)
Connect port to cmdResponseOut[portNum].
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
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.
virtual void lock()
Lock the guarded mutex.
Svc::InputSchedPort * get_schedIn_InputPort(FwIndexType portNum)
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.
bool isConnected_logOut_OutputPort(FwIndexType portNum) const
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.
static constexpr FwIndexType getNum_logOut_OutputPorts()
static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts()
void cmdIn_handlerBase(FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
Handler base-class function for input port cmdIn.
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 ENABLE_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void VERSION_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Svc::VersionType &version_type)=0
void tlmWrite_CustomVersion04(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion04.
bool isConnected_timeCaller_OutputPort(FwIndexType portNum) const
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
static constexpr FwIndexType getNum_schedIn_InputPorts()
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
VersionComponentBase(const char *compName="")
Construct VersionComponentBase object.
void log_ACTIVITY_LO_LibraryVersions(const Fw::StringBase &version) const
Tracks versions for project, framework and user defined versions etc.
void tlmWrite_CustomVersion08(const Svc::CustomVersionDb &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel CustomVersion08.
bool isConnected_cmdResponseOut_OutputPort(FwIndexType portNum) const
void tlmWrite_LibraryVersion09(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
Write telemetry channel LibraryVersion09.
static constexpr FwIndexType getNum_setVersion_InputPorts()
void tlmWrite_FrameworkVersion(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const
void set_cmdRegOut_OutputPort(FwIndexType portNum, Fw::InputCmdRegPort *port)
Connect port to cmdRegOut[portNum].
void set_timeCaller_OutputPort(FwIndexType portNum, Fw::InputTimePort *port)
Connect port to timeCaller[portNum].
void tlmWrite_ProjectVersion(const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time()) const