![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for FileManager component. More...
#include <Svc/FileManager/FileManagerComponentAc.hpp>
Public Member Functions | |
| void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
| Initialize FileManagerComponentBase object. More... | |
| Fw::InputCmdPort * | get_cmdIn_InputPort (FwIndexType portNum) |
| Svc::InputPingPort * | get_pingIn_InputPort (FwIndexType portNum) |
| void | set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
| Connect port to cmdRegOut[portNum]. More... | |
| void | set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
| Connect port to cmdResponseOut[portNum]. More... | |
| void | set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
| Connect port to eventOut[portNum]. More... | |
| void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
| Connect port to timeCaller[portNum]. More... | |
| void | set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
| Connect port to tlmOut[portNum]. More... | |
| void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
| Connect port to pingOut[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. More... | |
Public Member Functions inherited from Fw::ActiveComponentBase | |
| void | start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT) |
| called by instantiator when task is to be started More... | |
| void | exit () |
| exit task in active component More... | |
| Os::Task::Status | join () |
| Join the thread. More... | |
| DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
| Join to thread with discarded value_ptr. More... | |
Public Member Functions inherited from Fw::PassiveComponentBase | |
| void | setIdBase (const U32) |
| Set the ID base. More... | |
| U32 | getIdBase () const |
Protected Member Functions | |
| FileManagerComponentBase (const char *compName="") | |
| Construct FileManagerComponentBase object. More... | |
| virtual | ~FileManagerComponentBase () |
| Destroy FileManagerComponentBase object. More... | |
| FwIndexType | getNum_cmdIn_InputPorts () const |
| FwIndexType | getNum_pingIn_InputPorts () const |
| FwIndexType | getNum_cmdRegOut_OutputPorts () const |
| FwIndexType | getNum_cmdResponseOut_OutputPorts () const |
| FwIndexType | getNum_eventOut_OutputPorts () const |
| FwIndexType | getNum_timeCaller_OutputPorts () const |
| FwIndexType | getNum_tlmOut_OutputPorts () const |
| FwIndexType | getNum_pingOut_OutputPorts () const |
| bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_eventOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
| bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
| virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
| Handler for input port pingIn. More... | |
| void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
| Handler base-class function for input port pingIn. More... | |
| virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
| Pre-message hook for async input port pingIn. More... | |
| void | pingOut_out (FwIndexType portNum, U32 key) |
| Invoke output port pingOut. More... | |
| void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
| Emit command response. More... | |
| virtual void | CreateDirectory_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 |
| virtual void | RemoveDirectory_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &dirName)=0 |
| virtual void | RemoveFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, bool ignoreErrors)=0 |
| virtual void | ShellCommand_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &command, const Fw::CmdStringArg &logFileName)=0 |
| virtual void | AppendFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &source, const Fw::CmdStringArg &target)=0 |
| virtual void | FileSize_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0 |
| Handler for command FileSize. More... | |
| void | CreateDirectory_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | MoveFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | RemoveDirectory_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | RemoveFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | ShellCommand_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | AppendFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | FileSize_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| Base-class handler function for command FileSize. More... | |
| virtual void | CreateDirectory_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CreateDirectory. More... | |
| virtual void | MoveFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command MoveFile. More... | |
| virtual void | RemoveDirectory_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command RemoveDirectory. More... | |
| virtual void | RemoveFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command RemoveFile. More... | |
| virtual void | ShellCommand_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command ShellCommand. More... | |
| virtual void | AppendFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command AppendFile. More... | |
| virtual void | FileSize_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command FileSize. More... | |
| void | log_WARNING_HI_DirectoryCreateError (const Fw::StringBase &dirName, U32 status) const |
| void | log_WARNING_HI_DirectoryRemoveError (const Fw::StringBase &dirName, U32 status) const |
| void | log_WARNING_HI_FileMoveError (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 status) const |
| void | log_WARNING_HI_FileRemoveError (const Fw::StringBase &fileName, U32 status) const |
| void | log_WARNING_HI_ShellCommandFailed (const Fw::StringBase &command, U32 status) const |
| void | log_WARNING_HI_AppendFileFailed (const Fw::StringBase &source, const Fw::StringBase &target, U32 status) const |
| void | log_ACTIVITY_HI_AppendFileSucceeded (const Fw::StringBase &source, const Fw::StringBase &target) const |
| void | log_ACTIVITY_HI_ShellCommandSucceeded (const Fw::StringBase &command) const |
| void | log_ACTIVITY_HI_CreateDirectorySucceeded (const Fw::StringBase &dirName) const |
| void | log_ACTIVITY_HI_RemoveDirectorySucceeded (const Fw::StringBase &dirName) const |
| void | log_ACTIVITY_HI_MoveFileSucceeded (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName) const |
| void | log_ACTIVITY_HI_RemoveFileSucceeded (const Fw::StringBase &fileName) const |
| void | log_ACTIVITY_HI_AppendFileStarted (const Fw::StringBase &source, const Fw::StringBase &target) const |
| void | log_ACTIVITY_HI_ShellCommandStarted (const Fw::StringBase &command) const |
| void | log_ACTIVITY_HI_CreateDirectoryStarted (const Fw::StringBase &dirName) const |
| void | log_ACTIVITY_HI_RemoveDirectoryStarted (const Fw::StringBase &dirName) const |
| void | log_ACTIVITY_HI_MoveFileStarted (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName) const |
| void | log_ACTIVITY_HI_RemoveFileStarted (const Fw::StringBase &fileName) const |
| void | log_ACTIVITY_HI_FileSizeSucceeded (const Fw::StringBase &fileName, U64 size) const |
| void | log_WARNING_HI_FileSizeError (const Fw::StringBase &fileName, U32 status) const |
| void | log_ACTIVITY_HI_FileSizeStarted (const Fw::StringBase &fileName) const |
| void | tlmWrite_CommandsExecuted (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_Errors (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| Fw::Time | getTime () |
Protected Member Functions inherited from Fw::ActiveComponentBase | |
| ActiveComponentBase (const char *name) | |
| Constructor. More... | |
| virtual | ~ActiveComponentBase () |
| Destructor. More... | |
| void | init (NATIVE_INT_TYPE instance) |
| initialization code More... | |
| virtual void | preamble () |
| A function that will be called before the event loop is entered. More... | |
| MsgDispatchStatus | dispatch () |
| The function that will dispatching messages. More... | |
| virtual void | finalizer () |
| A function that will be called after exiting the loop. More... | |
Protected Member Functions inherited from Fw::QueuedComponentBase | |
| QueuedComponentBase (const char *name) | |
| Constructor. More... | |
| virtual | ~QueuedComponentBase () |
| Destructor. More... | |
| void | init (NATIVE_INT_TYPE instance) |
| initialization function More... | |
| Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
| NATIVE_INT_TYPE | getNumMsgsDropped () |
| return number of messages dropped More... | |
| void | incNumMsgDropped () |
| increment the number of messages dropped More... | |
Protected Member Functions inherited from Fw::PassiveComponentBase | |
| PassiveComponentBase (const char *name) | |
| Named constructor. More... | |
| virtual | ~PassiveComponentBase () |
| Destructor. More... | |
| void | init (NATIVE_INT_TYPE instance) |
| Initialization function. More... | |
| NATIVE_INT_TYPE | getInstance () const |
Protected Member Functions inherited from Fw::ObjBase | |
| ObjBase (const char *name) | |
| ObjBase constructor. More... | |
| virtual | ~ObjBase () |
| Destructor. More... | |
| void | init () |
| Object initializer. More... | |
Friends | |
| class | FileManagerComponentBaseFriend |
| Friend class for white-box testing. More... | |
Additional Inherited Members | |
Public Types inherited from Fw::ActiveComponentBase | |
| enum | { ACTIVE_COMPONENT_EXIT } |
Public Types inherited from Fw::QueuedComponentBase | |
| enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
Protected Attributes inherited from Fw::ActiveComponentBase | |
| Os::Task | m_task |
| task object for active component More... | |
Protected Attributes inherited from Fw::QueuedComponentBase | |
| Os::Queue | m_queue |
| queue object for active component More... | |
Auto-generated base for FileManager component.
A component for managing files
Definition at line 34 of file FileManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDIN_INPUT_PORTS | |
Definition at line 52 of file FileManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_PINGIN_INPUT_PORTS | |
Definition at line 57 of file FileManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
| Enumerator | |
|---|---|
| NUM_LOGTEXT_OUTPUT_PORTS | |
| NUM_CMDREGOUT_OUTPUT_PORTS | |
| NUM_CMDRESPONSEOUT_OUTPUT_PORTS | |
| NUM_EVENTOUT_OUTPUT_PORTS | |
| NUM_TIMECALLER_OUTPUT_PORTS | |
| NUM_TLMOUT_OUTPUT_PORTS | |
Definition at line 62 of file FileManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_PINGOUT_OUTPUT_PORTS | |
Definition at line 72 of file FileManagerComponentAc.hpp.
|
protected |
Command opcodes.
Definition at line 77 of file FileManagerComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 88 of file FileManagerComponentAc.hpp.
|
protected |
Channel IDs.
| Enumerator | |
|---|---|
| CHANNELID_COMMANDSEXECUTED | Channel ID for CommandsExecuted. |
| CHANNELID_ERRORS | Channel ID for Errors. |
Definition at line 113 of file FileManagerComponentAc.hpp.
|
protected |
Construct FileManagerComponentBase object.
| compName | The component name |
Definition at line 580 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Destroy FileManagerComponentBase object.
Definition at line 587 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command AppendFile
Append 1 file's contents to the end of another.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| source | The name of the file to take content from |
| target | The name of the file to append to |
|
protected |
Base-class handler function for command AppendFile
Append 1 file's contents to the end of another.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1167 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command AppendFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1348 of file FileManagerComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 855 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CreateDirectory
Create a directory
| opCode | The opcode |
| cmdSeq | The command sequence number |
| dirName | The directory to create |
|
protected |
Base-class handler function for command CreateDirectory
Create a directory
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 872 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CreateDirectory.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1293 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command FileSize.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The file to get the size of |
|
protected |
Base-class handler function for command FileSize.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1226 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command FileSize.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1359 of file FileManagerComponentAc.cpp.
| Fw::InputCmdPort * Svc::FileManagerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 284 of file FileManagerComponentAc.cpp.
| Svc::InputPingPort * Svc::FileManagerComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 299 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 597 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 627 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 633 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of eventOut output ports
Definition at line 639 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 607 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 661 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 645 of file FileManagerComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 651 of file FileManagerComponentAc.cpp.
|
protected |
| void Svc::FileManagerComponentBase::init | ( | FwSizeType | queueDepth, |
| FwEnumStoreType | instance = 0 |
||
| ) |
Initialize FileManagerComponentBase object.
| queueDepth | The queue depth |
| instance | The instance number |
Definition at line 77 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
| portNum | The port number |
Definition at line 686 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
| portNum | The port number |
Definition at line 697 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
| portNum | The port number |
Definition at line 708 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
| portNum | The port number |
Definition at line 745 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 719 of file FileManagerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
| portNum | The port number |
Definition at line 730 of file FileManagerComponentAc.cpp.
|
protected |
Log event AppendFileStarted
The File System component appended 2 files without error
| source | The name of the file being read from |
| target | The name of the file to append to |
Definition at line 2394 of file FileManagerComponentAc.cpp.
|
protected |
Log event AppendFileSucceeded
The File System component appended 2 files without error
| source | The name of the file being read from |
| target | The name of the file to append to |
Definition at line 1942 of file FileManagerComponentAc.cpp.
|
protected |
Log event CreateDirectoryStarted
The File System component began creating a new directory
| dirName | The name of the directory |
Definition at line 2548 of file FileManagerComponentAc.cpp.
|
protected |
Log event CreateDirectorySucceeded
The File System component created a new directory without error
| dirName | The name of the directory |
Definition at line 2096 of file FileManagerComponentAc.cpp.
|
protected |
Log event FileSizeStarted
Checking file size
| fileName | The name of the file |
Definition at line 3030 of file FileManagerComponentAc.cpp.
|
protected |
Log event FileSizeSucceeded
File size response
| fileName | The name of the file |
| size | The size of the file in bytes |
Definition at line 2846 of file FileManagerComponentAc.cpp.
|
protected |
Log event MoveFileStarted
The File System component began moving a file to a new location
| sourceFileName | The name of the source file |
| destFileName | The name of the destination file |
Definition at line 2692 of file FileManagerComponentAc.cpp.
|
protected |
Log event MoveFileSucceeded
The File System component moved a file to a new location without error
| sourceFileName | The name of the source file |
| destFileName | The name of the destination file |
Definition at line 2240 of file FileManagerComponentAc.cpp.
|
protected |
Log event RemoveDirectoryStarted
The File System component began deleting a directory
| dirName | The name of the directory |
Definition at line 2620 of file FileManagerComponentAc.cpp.
|
protected |
Log event RemoveDirectorySucceeded
The File System component deleted and existing directory without error
| dirName | The name of the directory |
Definition at line 2168 of file FileManagerComponentAc.cpp.
|
protected |
Log event RemoveFileStarted
The File System component began deleting an existing file
| fileName | The name of the file |
Definition at line 2774 of file FileManagerComponentAc.cpp.
|
protected |
Log event RemoveFileSucceeded
The File System component deleted an existing file without error
| fileName | The name of the file |
Definition at line 2322 of file FileManagerComponentAc.cpp.
|
protected |
Log event ShellCommandStarted
The File System component began executing a shell command
| command | The command string |
Definition at line 2476 of file FileManagerComponentAc.cpp.
|
protected |
Log event ShellCommandSucceeded
The File System component executed a shell command that returned status zero
| command | The command string |
Definition at line 2024 of file FileManagerComponentAc.cpp.
|
protected |
Log event AppendFileFailed
The File System component returned status non-zero when trying to append 2 files together
| source | The name of the file being read from |
| target | The name of the file to append to |
| status | The error status |
Definition at line 1842 of file FileManagerComponentAc.cpp.
|
protected |
Log event DirectoryCreateError
An error occurred while attempting to create a directory
| dirName | The name of the directory |
| status | The error status |
Definition at line 1374 of file FileManagerComponentAc.cpp.
|
protected |
Log event DirectoryRemoveError
An error occurred while attempting to remove a directory
| dirName | The name of the directory |
| status | The error status |
Definition at line 1466 of file FileManagerComponentAc.cpp.
|
protected |
Log event FileMoveError
An error occurred while attempting to move a file
| sourceFileName | The name of the source file |
| destFileName | The name of the destination file |
| status | The error status |
Definition at line 1558 of file FileManagerComponentAc.cpp.
|
protected |
Log event FileRemoveError
An error occurred while attempting to remove a file
| fileName | The name of the file |
| status | The error status |
Definition at line 1658 of file FileManagerComponentAc.cpp.
|
protected |
Log event FileSizeError
Failed to get file size
| fileName | The name of the file |
| status | The error status |
Definition at line 2938 of file FileManagerComponentAc.cpp.
|
protected |
Log event ShellCommandFailed
The File System component executed a shell command that returned status non-zero
| command | The command string |
| status | The status code |
Definition at line 1750 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command MoveFile
Move a file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| sourceFileName | The source file name |
| destFileName | The destination file name |
|
protected |
Base-class handler function for command MoveFile
Move a file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 931 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command MoveFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1304 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 762 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 823 of file FileManagerComponentAc.cpp.
|
protected |
Invoke output port pingOut.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 836 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 542 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command RemoveDirectory
Remove a directory, which must be empty
| opCode | The opcode |
| cmdSeq | The command sequence number |
| dirName | The directory to remove |
|
protected |
Base-class handler function for command RemoveDirectory
Remove a directory, which must be empty
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 990 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command RemoveDirectory.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1315 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command RemoveFile
Remove a file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The file to remove |
| ignoreErrors | Ignore nonexistent files |
|
protected |
Base-class handler function for command RemoveFile
Remove a file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1049 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command RemoveFile.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1326 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to cmdRegOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 332 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to cmdResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 346 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_eventOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to eventOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 360 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputPingPort * | port | ||
| ) |
Connect port to pingOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 406 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 374 of file FileManagerComponentAc.cpp.
| void Svc::FileManagerComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to tlmOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 388 of file FileManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command ShellCommand
Perform a Linux shell command and write the output to a log file.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| command | The shell command string |
| logFileName | The name of the log file |
|
protected |
Base-class handler function for command ShellCommand
Perform a Linux shell command and write the output to a log file.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1108 of file FileManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command ShellCommand.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1337 of file FileManagerComponentAc.cpp.
|
protected |
Write telemetry channel CommandsExecuted
The total number of commands successfully executed
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 3106 of file FileManagerComponentAc.cpp.
|
protected |
Write telemetry channel Errors
The total number of errors
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 3139 of file FileManagerComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 43 of file FileManagerComponentAc.hpp.