F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
FileManagerComponentAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title FileManagerComponentAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for FileManager component base class
5 // ======================================================================
6 
7 #ifndef Svc_FileManagerComponentAc_HPP
8 #define Svc_FileManagerComponentAc_HPP
9 
10 #include "FpConfig.hpp"
11 #include "Fw/Cmd/CmdPortAc.hpp"
12 #include "Fw/Cmd/CmdRegPortAc.hpp"
14 #include "Fw/Cmd/CmdString.hpp"
16 #include "Fw/Log/LogPortAc.hpp"
17 #include "Fw/Log/LogString.hpp"
18 #if FW_ENABLE_TEXT_LOGGING == 1
19 #include "Fw/Log/LogTextPortAc.hpp"
20 #endif
23 #include "Fw/Time/TimePortAc.hpp"
24 #include "Fw/Tlm/TlmPortAc.hpp"
25 #include "Fw/Tlm/TlmString.hpp"
26 #include "Svc/Ping/PingPortAc.hpp"
27 
28 namespace Svc {
29 
36  {
37 
38  // ----------------------------------------------------------------------
39  // Friend classes
40  // ----------------------------------------------------------------------
41 
44 
45  PROTECTED:
46 
47  // ----------------------------------------------------------------------
48  // Constants
49  // ----------------------------------------------------------------------
50 
52  enum {
54  };
55 
57  enum {
59  };
60 
62  enum {
69  };
70 
72  enum {
74  };
75 
77  enum {
85  };
86 
88  enum {
110  };
111 
113  enum {
116  };
117 
118  public:
119 
120  // ----------------------------------------------------------------------
121  // Component initialization
122  // ----------------------------------------------------------------------
123 
125  void init(
126  FwSizeType queueDepth,
127  FwEnumStoreType instance = 0
128  );
129 
130  public:
131 
132  // ----------------------------------------------------------------------
133  // Getters for special input ports
134  // ----------------------------------------------------------------------
135 
140  FwIndexType portNum
141  );
142 
143  public:
144 
145  // ----------------------------------------------------------------------
146  // Getters for typed input ports
147  // ----------------------------------------------------------------------
148 
153  FwIndexType portNum
154  );
155 
156  public:
157 
158  // ----------------------------------------------------------------------
159  // Connect input ports to special output ports
160  // ----------------------------------------------------------------------
161 
162 #if FW_ENABLE_TEXT_LOGGING == 1
163 
165  void set_LogText_OutputPort(
166  FwIndexType portNum,
167  Fw::InputLogTextPort* port
168  );
169 
170 #endif
171 
174  FwIndexType portNum,
175  Fw::InputCmdRegPort* port
176  );
177 
180  FwIndexType portNum,
182  );
183 
186  FwIndexType portNum,
187  Fw::InputLogPort* port
188  );
189 
192  FwIndexType portNum,
193  Fw::InputTimePort* port
194  );
195 
198  FwIndexType portNum,
199  Fw::InputTlmPort* port
200  );
201 
202  public:
203 
204  // ----------------------------------------------------------------------
205  // Connect typed input ports to typed output ports
206  // ----------------------------------------------------------------------
207 
210  FwIndexType portNum,
211  Svc::InputPingPort* port
212  );
213 
214 #if FW_PORT_SERIALIZATION
215 
216  public:
217 
218  // ----------------------------------------------------------------------
219  // Connect serial input ports to special output ports
220  // ----------------------------------------------------------------------
221 
222 #if FW_ENABLE_TEXT_LOGGING == 1
223 
225  void set_LogText_OutputPort(
226  FwIndexType portNum,
227  Fw::InputSerializePort* port
228  );
229 
230 #endif
231 
234  FwIndexType portNum,
235  Fw::InputSerializePort* port
236  );
237 
240  FwIndexType portNum,
241  Fw::InputSerializePort* port
242  );
243 
246  FwIndexType portNum,
247  Fw::InputSerializePort* port
248  );
249 
252  FwIndexType portNum,
253  Fw::InputSerializePort* port
254  );
255 
258  FwIndexType portNum,
259  Fw::InputSerializePort* port
260  );
261 
262 #endif
263 
264 #if FW_PORT_SERIALIZATION
265 
266  public:
267 
268  // ----------------------------------------------------------------------
269  // Connect serial input ports to typed output ports
270  // ----------------------------------------------------------------------
271 
274  FwIndexType portNum,
275  Fw::InputSerializePort* port
276  );
277 
278 #endif
279 
280  public:
281 
282  // ----------------------------------------------------------------------
283  // Command registration
284  // ----------------------------------------------------------------------
285 
289  void regCommands();
290 
291  PROTECTED:
292 
293  // ----------------------------------------------------------------------
294  // Component construction and destruction
295  // ----------------------------------------------------------------------
296 
299  const char* compName = ""
300  );
301 
303  virtual ~FileManagerComponentBase();
304 
305  PROTECTED:
306 
307  // ----------------------------------------------------------------------
308  // Getters for numbers of special input ports
309  // ----------------------------------------------------------------------
310 
315 
316  PROTECTED:
317 
318  // ----------------------------------------------------------------------
319  // Getters for numbers of typed input ports
320  // ----------------------------------------------------------------------
321 
326 
327  PROTECTED:
328 
329  // ----------------------------------------------------------------------
330  // Getters for numbers of special output ports
331  // ----------------------------------------------------------------------
332 
333 #if FW_ENABLE_TEXT_LOGGING == 1
334 
338  FwIndexType getNum_LogText_OutputPorts() const;
339 
340 #endif
341 
346 
351 
356 
361 
366 
367  PROTECTED:
368 
369  // ----------------------------------------------------------------------
370  // Getters for numbers of typed output ports
371  // ----------------------------------------------------------------------
372 
377 
378  PROTECTED:
379 
380  // ----------------------------------------------------------------------
381  // Connection status queries for special output ports
382  // ----------------------------------------------------------------------
383 
384 #if FW_ENABLE_TEXT_LOGGING == 1
385 
389  bool isConnected_LogText_OutputPort(
390  FwIndexType portNum
391  );
392 
393 #endif
394 
399  FwIndexType portNum
400  );
401 
406  FwIndexType portNum
407  );
408 
413  FwIndexType portNum
414  );
415 
420  FwIndexType portNum
421  );
422 
427  FwIndexType portNum
428  );
429 
430  PROTECTED:
431 
432  // ----------------------------------------------------------------------
433  // Connection status queries for typed output ports
434  // ----------------------------------------------------------------------
435 
440  FwIndexType portNum
441  );
442 
443  PROTECTED:
444 
445  // ----------------------------------------------------------------------
446  // Handlers to implement for typed input ports
447  // ----------------------------------------------------------------------
448 
450  virtual void pingIn_handler(
451  FwIndexType portNum,
452  U32 key
453  ) = 0;
454 
455  PROTECTED:
456 
457  // ----------------------------------------------------------------------
458  // Port handler base-class functions for typed input ports
459  //
460  // Call these functions directly to bypass the corresponding ports
461  // ----------------------------------------------------------------------
462 
464  void pingIn_handlerBase(
465  FwIndexType portNum,
466  U32 key
467  );
468 
469  PROTECTED:
470 
471  // ----------------------------------------------------------------------
472  // Pre-message hooks for typed async input ports
473  //
474  // Each of these functions is invoked just before processing a message
475  // on the corresponding port. By default, they do nothing. You can
476  // override them to provide specific pre-message behavior.
477  // ----------------------------------------------------------------------
478 
480  virtual void pingIn_preMsgHook(
481  FwIndexType portNum,
482  U32 key
483  );
484 
485  PROTECTED:
486 
487  // ----------------------------------------------------------------------
488  // Invocation functions for typed output ports
489  // ----------------------------------------------------------------------
490 
492  void pingOut_out(
493  FwIndexType portNum,
494  U32 key
495  );
496 
497  PROTECTED:
498 
499  // ----------------------------------------------------------------------
500  // Command response
501  // ----------------------------------------------------------------------
502 
504  void cmdResponse_out(
505  FwOpcodeType opCode,
506  U32 cmdSeq,
507  Fw::CmdResponse response
508  );
509 
510  PROTECTED:
511 
512  // ----------------------------------------------------------------------
513  // Command handlers to implement
514  // ----------------------------------------------------------------------
515 
520  FwOpcodeType opCode,
521  U32 cmdSeq,
522  const Fw::CmdStringArg& dirName
523  ) = 0;
524 
528  virtual void MoveFile_cmdHandler(
529  FwOpcodeType opCode,
530  U32 cmdSeq,
531  const Fw::CmdStringArg& sourceFileName,
532  const Fw::CmdStringArg& destFileName
533  ) = 0;
534 
539  FwOpcodeType opCode,
540  U32 cmdSeq,
541  const Fw::CmdStringArg& dirName
542  ) = 0;
543 
547  virtual void RemoveFile_cmdHandler(
548  FwOpcodeType opCode,
549  U32 cmdSeq,
550  const Fw::CmdStringArg& fileName,
551  bool ignoreErrors
552  ) = 0;
553 
558  FwOpcodeType opCode,
559  U32 cmdSeq,
560  const Fw::CmdStringArg& command,
561  const Fw::CmdStringArg& logFileName
562  ) = 0;
563 
567  virtual void AppendFile_cmdHandler(
568  FwOpcodeType opCode,
569  U32 cmdSeq,
570  const Fw::CmdStringArg& source,
571  const Fw::CmdStringArg& target
572  ) = 0;
573 
575  virtual void FileSize_cmdHandler(
576  FwOpcodeType opCode,
577  U32 cmdSeq,
578  const Fw::CmdStringArg& fileName
579  ) = 0;
580 
581  PROTECTED:
582 
583  // ----------------------------------------------------------------------
584  // Command handler base-class functions
585  //
586  // Call these functions directly to bypass the command input port
587  // ----------------------------------------------------------------------
588 
593  FwOpcodeType opCode,
594  U32 cmdSeq,
595  Fw::CmdArgBuffer& args
596  );
597 
602  FwOpcodeType opCode,
603  U32 cmdSeq,
604  Fw::CmdArgBuffer& args
605  );
606 
611  FwOpcodeType opCode,
612  U32 cmdSeq,
613  Fw::CmdArgBuffer& args
614  );
615 
620  FwOpcodeType opCode,
621  U32 cmdSeq,
622  Fw::CmdArgBuffer& args
623  );
624 
629  FwOpcodeType opCode,
630  U32 cmdSeq,
631  Fw::CmdArgBuffer& args
632  );
633 
638  FwOpcodeType opCode,
639  U32 cmdSeq,
640  Fw::CmdArgBuffer& args
641  );
642 
645  FwOpcodeType opCode,
646  U32 cmdSeq,
647  Fw::CmdArgBuffer& args
648  );
649 
650  PROTECTED:
651 
652  // ----------------------------------------------------------------------
653  // Pre-message hooks for async commands
654  //
655  // Each of these functions is invoked just before processing the
656  // corresponding command. By default they do nothing. You can
657  // override them to provide specific pre-command behavior.
658  // ----------------------------------------------------------------------
659 
661  virtual void CreateDirectory_preMsgHook(
662  FwOpcodeType opCode,
663  U32 cmdSeq
664  );
665 
667  virtual void MoveFile_preMsgHook(
668  FwOpcodeType opCode,
669  U32 cmdSeq
670  );
671 
673  virtual void RemoveDirectory_preMsgHook(
674  FwOpcodeType opCode,
675  U32 cmdSeq
676  );
677 
679  virtual void RemoveFile_preMsgHook(
680  FwOpcodeType opCode,
681  U32 cmdSeq
682  );
683 
685  virtual void ShellCommand_preMsgHook(
686  FwOpcodeType opCode,
687  U32 cmdSeq
688  );
689 
691  virtual void AppendFile_preMsgHook(
692  FwOpcodeType opCode,
693  U32 cmdSeq
694  );
695 
697  virtual void FileSize_preMsgHook(
698  FwOpcodeType opCode,
699  U32 cmdSeq
700  );
701 
702  PROTECTED:
703 
704  // ----------------------------------------------------------------------
705  // Event logging functions
706  // ----------------------------------------------------------------------
707 
712  const Fw::StringBase& dirName,
713  U32 status
714  );
715 
720  const Fw::StringBase& dirName,
721  U32 status
722  );
723 
728  const Fw::StringBase& sourceFileName,
729  const Fw::StringBase& destFileName,
730  U32 status
731  );
732 
737  const Fw::StringBase& fileName,
738  U32 status
739  );
740 
745  const Fw::StringBase& command,
746  U32 status
747  );
748 
753  const Fw::StringBase& source,
754  const Fw::StringBase& target,
755  U32 status
756  );
757 
762  const Fw::StringBase& source,
763  const Fw::StringBase& target
764  );
765 
770  const Fw::StringBase& command
771  );
772 
777  const Fw::StringBase& dirName
778  );
779 
784  const Fw::StringBase& dirName
785  );
786 
791  const Fw::StringBase& sourceFileName,
792  const Fw::StringBase& destFileName
793  );
794 
799  const Fw::StringBase& fileName
800  );
801 
806  const Fw::StringBase& source,
807  const Fw::StringBase& target
808  );
809 
814  const Fw::StringBase& command
815  );
816 
821  const Fw::StringBase& dirName
822  );
823 
828  const Fw::StringBase& dirName
829  );
830 
835  const Fw::StringBase& sourceFileName,
836  const Fw::StringBase& destFileName
837  );
838 
843  const Fw::StringBase& fileName
844  );
845 
850  const Fw::StringBase& fileName,
851  U64 size
852  );
853 
858  const Fw::StringBase& fileName,
859  U32 status
860  );
861 
866  const Fw::StringBase& fileName
867  );
868 
869  PROTECTED:
870 
871  // ----------------------------------------------------------------------
872  // Telemetry write functions
873  // ----------------------------------------------------------------------
874 
879  U32 arg,
880  Fw::Time _tlmTime = Fw::Time()
881  );
882 
886  void tlmWrite_Errors(
887  U32 arg,
888  Fw::Time _tlmTime = Fw::Time()
889  );
890 
891  PROTECTED:
892 
893  // ----------------------------------------------------------------------
894  // Time
895  // ----------------------------------------------------------------------
896 
900  Fw::Time getTime();
901 
902  PRIVATE:
903 
904  // ----------------------------------------------------------------------
905  // Message dispatch functions
906  // ----------------------------------------------------------------------
907 
909  virtual MsgDispatchStatus doDispatch();
910 
911  PRIVATE:
912 
913  // ----------------------------------------------------------------------
914  // Calls for messages received on special input ports
915  // ----------------------------------------------------------------------
916 
918  static void m_p_cmdIn_in(
919  Fw::PassiveComponentBase* callComp,
920  FwIndexType portNum,
921  FwOpcodeType opCode,
922  U32 cmdSeq,
923  Fw::CmdArgBuffer& args
924  );
925 
926  PRIVATE:
927 
928  // ----------------------------------------------------------------------
929  // Calls for messages received on typed input ports
930  // ----------------------------------------------------------------------
931 
933  static void m_p_pingIn_in(
934  Fw::PassiveComponentBase* callComp,
935  FwIndexType portNum,
936  U32 key
937  );
938 
939  PRIVATE:
940 
941  // ----------------------------------------------------------------------
942  // Special input ports
943  // ----------------------------------------------------------------------
944 
946  Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];
947 
948  PRIVATE:
949 
950  // ----------------------------------------------------------------------
951  // Typed input ports
952  // ----------------------------------------------------------------------
953 
955  Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];
956 
957  PRIVATE:
958 
959  // ----------------------------------------------------------------------
960  // Special output ports
961  // ----------------------------------------------------------------------
962 
963 #if FW_ENABLE_TEXT_LOGGING == 1
964 
966  Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];
967 
968 #endif
969 
971  Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];
972 
974  Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];
975 
977  Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];
978 
980  Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
981 
983  Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
984 
985  PRIVATE:
986 
987  // ----------------------------------------------------------------------
988  // Typed output ports
989  // ----------------------------------------------------------------------
990 
992  Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];
993 
994  };
995 
996 }
997 
998 #endif
I32 FwEnumStoreType
Definition: FpConfig.h:64
U32 FwOpcodeType
Definition: FpConfig.h:91
PlatformSizeType FwSizeType
Definition: FpConfig.h:35
PlatformIndexType FwIndexType
Definition: FpConfig.h:25
C++-compatible configuration header for fprime configuration.
Enum representing a command response.
void init()
Object initializer.
Definition: ObjBase.cpp:27
Definition: Time.hpp:9
Auto-generated base for FileManager component.
void log_ACTIVITY_HI_MoveFileSucceeded(const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
void log_ACTIVITY_HI_RemoveFileStarted(const Fw::StringBase &fileName)
void pingOut_out(FwIndexType portNum, U32 key)
Invoke output port pingOut.
bool isConnected_eventOut_OutputPort(FwIndexType portNum)
bool isConnected_tlmOut_OutputPort(FwIndexType portNum)
void log_ACTIVITY_HI_RemoveDirectorySucceeded(const Fw::StringBase &dirName)
void log_ACTIVITY_HI_MoveFileStarted(const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
void set_tlmOut_OutputPort(FwIndexType portNum, Fw::InputTlmPort *port)
Connect port to tlmOut[portNum].
void set_timeCaller_OutputPort(FwIndexType portNum, Fw::InputTimePort *port)
Connect port to timeCaller[portNum].
@ CHANNELID_ERRORS
Channel ID for Errors.
@ CHANNELID_COMMANDSEXECUTED
Channel ID for CommandsExecuted.
void log_ACTIVITY_HI_RemoveFileSucceeded(const Fw::StringBase &fileName)
virtual void FileSize_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command FileSize.
virtual void FileSize_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0
Handler for command FileSize.
void log_WARNING_HI_ShellCommandFailed(const Fw::StringBase &command, U32 status)
void set_cmdRegOut_OutputPort(FwIndexType portNum, Fw::InputCmdRegPort *port)
Connect port to cmdRegOut[portNum].
void ShellCommand_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void log_ACTIVITY_HI_ShellCommandSucceeded(const Fw::StringBase &command)
virtual void RemoveDirectory_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &dirName)=0
virtual void MoveFile_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &sourceFileName, const Fw::CmdStringArg &destFileName)=0
FwIndexType getNum_cmdRegOut_OutputPorts() const
bool isConnected_cmdResponseOut_OutputPort(FwIndexType portNum)
virtual void AppendFile_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command AppendFile.
void cmdResponse_out(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
Emit command response.
void tlmWrite_CommandsExecuted(U32 arg, Fw::Time _tlmTime=Fw::Time())
void tlmWrite_Errors(U32 arg, Fw::Time _tlmTime=Fw::Time())
virtual void ShellCommand_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &command, const Fw::CmdStringArg &logFileName)=0
void regCommands()
Register commands with the Command Dispatcher.
void AppendFile_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
FwIndexType getNum_timeCaller_OutputPorts() const
void FileSize_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
Base-class handler function for command FileSize.
void pingIn_handlerBase(FwIndexType portNum, U32 key)
Handler base-class function for input port pingIn.
Fw::InputCmdPort * get_cmdIn_InputPort(FwIndexType portNum)
void log_ACTIVITY_HI_AppendFileSucceeded(const Fw::StringBase &source, const Fw::StringBase &target)
virtual ~FileManagerComponentBase()
Destroy FileManagerComponentBase object.
virtual void CreateDirectory_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command CreateDirectory.
void set_eventOut_OutputPort(FwIndexType portNum, Fw::InputLogPort *port)
Connect port to eventOut[portNum].
void log_WARNING_HI_DirectoryRemoveError(const Fw::StringBase &dirName, U32 status)
friend class FileManagerComponentBaseFriend
Friend class for white-box testing.
void RemoveDirectory_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void AppendFile_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &source, const Fw::CmdStringArg &target)=0
virtual void RemoveFile_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command RemoveFile.
bool isConnected_pingOut_OutputPort(FwIndexType portNum)
@ EVENTID_APPENDFILESUCCEEDED
The File System component appended 2 files without error.
@ EVENTID_REMOVEFILESTARTED
The File System component began deleting an existing file.
@ EVENTID_FILESIZEERROR
Failed to get file size.
@ EVENTID_DIRECTORYREMOVEERROR
An error occurred while attempting to remove a directory.
@ EVENTID_FILESIZESTARTED
Checking file size.
@ EVENTID_APPENDFILESTARTED
The File System component appended 2 files without error.
@ EVENTID_SHELLCOMMANDSTARTED
The File System component began executing a shell command.
@ EVENTID_APPENDFILEFAILED
The File System component returned status non-zero when trying to append 2 files together.
@ EVENTID_FILESIZESUCCEEDED
File size response.
@ EVENTID_MOVEFILESTARTED
The File System component began moving a file to a new location.
@ EVENTID_FILEREMOVEERROR
An error occurred while attempting to remove a file.
@ EVENTID_REMOVEDIRECTORYSTARTED
The File System component began deleting a directory.
@ EVENTID_SHELLCOMMANDFAILED
The File System component executed a shell command that returned status non-zero.
@ EVENTID_CREATEDIRECTORYSUCCEEDED
The File System component created a new directory without error.
@ EVENTID_MOVEFILESUCCEEDED
The File System component moved a file to a new location without error.
@ EVENTID_REMOVEDIRECTORYSUCCEEDED
The File System component deleted and existing directory without error.
@ EVENTID_DIRECTORYCREATEERROR
An error occurred while attempting to create a directory.
@ EVENTID_CREATEDIRECTORYSTARTED
The File System component began creating a new directory.
@ EVENTID_SHELLCOMMANDSUCCEEDED
The File System component executed a shell command that returned status zero.
@ EVENTID_FILEMOVEERROR
An error occurred while attempting to move a file.
@ EVENTID_REMOVEFILESUCCEEDED
The File System component deleted an existing file without error.
void log_ACTIVITY_HI_FileSizeStarted(const Fw::StringBase &fileName)
void MoveFile_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void set_cmdResponseOut_OutputPort(FwIndexType portNum, Fw::InputCmdResponsePort *port)
Connect port to cmdResponseOut[portNum].
@ OPCODE_CREATEDIRECTORY
Create a directory.
@ OPCODE_REMOVEDIRECTORY
Remove a directory, which must be empty.
@ OPCODE_SHELLCOMMAND
Perform a Linux shell command and write the output to a log file.
@ OPCODE_APPENDFILE
Append 1 file's contents to the end of another.
void CreateDirectory_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void set_pingOut_OutputPort(FwIndexType portNum, Svc::InputPingPort *port)
Connect port to pingOut[portNum].
void log_WARNING_HI_FileMoveError(const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 status)
bool isConnected_cmdRegOut_OutputPort(FwIndexType portNum)
Svc::InputPingPort * get_pingIn_InputPort(FwIndexType portNum)
virtual void RemoveDirectory_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command RemoveDirectory.
void log_ACTIVITY_HI_RemoveDirectoryStarted(const Fw::StringBase &dirName)
void log_WARNING_HI_FileSizeError(const Fw::StringBase &fileName, U32 status)
virtual void pingIn_preMsgHook(FwIndexType portNum, U32 key)
Pre-message hook for async input port pingIn.
FileManagerComponentBase(const char *compName="")
Construct FileManagerComponentBase object.
void RemoveFile_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void log_WARNING_HI_DirectoryCreateError(const Fw::StringBase &dirName, U32 status)
void log_WARNING_HI_AppendFileFailed(const Fw::StringBase &source, const Fw::StringBase &target, U32 status)
void log_ACTIVITY_HI_CreateDirectorySucceeded(const Fw::StringBase &dirName)
void log_ACTIVITY_HI_ShellCommandStarted(const Fw::StringBase &command)
virtual void RemoveFile_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, bool ignoreErrors)=0
FwIndexType getNum_eventOut_OutputPorts() const
virtual void CreateDirectory_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &dirName)=0
void log_ACTIVITY_HI_CreateDirectoryStarted(const Fw::StringBase &dirName)
void log_ACTIVITY_HI_AppendFileStarted(const Fw::StringBase &source, const Fw::StringBase &target)
FwIndexType getNum_cmdResponseOut_OutputPorts() const
void log_WARNING_HI_FileRemoveError(const Fw::StringBase &fileName, U32 status)
void log_ACTIVITY_HI_FileSizeSucceeded(const Fw::StringBase &fileName, U64 size)
virtual void MoveFile_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command MoveFile.
bool isConnected_timeCaller_OutputPort(FwIndexType portNum)
virtual void ShellCommand_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command ShellCommand.
FwIndexType getNum_pingOut_OutputPorts() const
virtual void pingIn_handler(FwIndexType portNum, U32 key)=0
Handler for input port pingIn.
#define U64(C)
Definition: sha.h:176