F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::FileManager Class Reference

#include <Svc/FileManager/FileManager.hpp>

Inheritance diagram for Svc::FileManager:
Svc::FileManagerComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 FileManager (const char *const compName)
 
 ~FileManager ()
 
- Public Member Functions inherited from Svc::FileManagerComponentBase
void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize FileManagerComponentBase object. More...
 
Fw::InputCmdPortget_cmdIn_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_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
 

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 Types inherited from Svc::FileManagerComponentBase
enum  { NUM_CMDIN_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_PINGIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 ,
  NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_PINGOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  {
  OPCODE_CREATEDIRECTORY = 0x0 , OPCODE_MOVEFILE = 0x1 , OPCODE_REMOVEDIRECTORY = 0x2 , OPCODE_REMOVEFILE = 0x3 ,
  OPCODE_SHELLCOMMAND = 0x4 , OPCODE_APPENDFILE = 0x5 , OPCODE_FILESIZE = 0x6
}
 Command opcodes. More...
 
enum  {
  EVENTID_DIRECTORYCREATEERROR = 0x0 , EVENTID_DIRECTORYREMOVEERROR = 0x1 , EVENTID_FILEMOVEERROR = 0x2 , EVENTID_FILEREMOVEERROR = 0x3 ,
  EVENTID_SHELLCOMMANDFAILED = 0x4 , EVENTID_APPENDFILEFAILED = 0x5 , EVENTID_APPENDFILESUCCEEDED = 0x6 , EVENTID_SHELLCOMMANDSUCCEEDED = 0x7 ,
  EVENTID_CREATEDIRECTORYSUCCEEDED = 0x8 , EVENTID_REMOVEDIRECTORYSUCCEEDED = 0x9 , EVENTID_MOVEFILESUCCEEDED = 0xa , EVENTID_REMOVEFILESUCCEEDED = 0xb ,
  EVENTID_APPENDFILESTARTED = 0xc , EVENTID_SHELLCOMMANDSTARTED = 0xd , EVENTID_CREATEDIRECTORYSTARTED = 0xe , EVENTID_REMOVEDIRECTORYSTARTED = 0xf ,
  EVENTID_MOVEFILESTARTED = 0x10 , EVENTID_REMOVEFILESTARTED = 0x11 , EVENTID_FILESIZESUCCEEDED = 0x12 , EVENTID_FILESIZEERROR = 0x13 ,
  EVENTID_FILESIZESTARTED = 0x14
}
 Event IDs. More...
 
enum  { CHANNELID_COMMANDSEXECUTED = 0x0 , CHANNELID_ERRORS = 0x1 }
 Channel IDs. More...
 
- Protected Types inherited from Fw::ActiveComponentBase
enum  Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
 Tracks the lifecycle of the component. More...
 
- Protected Member Functions inherited from Svc::FileManagerComponentBase
 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)
 
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...
 
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)
 
void log_WARNING_HI_DirectoryRemoveError (const Fw::StringBase &dirName, U32 status)
 
void log_WARNING_HI_FileMoveError (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 status)
 
void log_WARNING_HI_FileRemoveError (const Fw::StringBase &fileName, U32 status)
 
void log_WARNING_HI_ShellCommandFailed (const Fw::StringBase &command, U32 status)
 
void log_WARNING_HI_AppendFileFailed (const Fw::StringBase &source, const Fw::StringBase &target, U32 status)
 
void log_ACTIVITY_HI_AppendFileSucceeded (const Fw::StringBase &source, const Fw::StringBase &target)
 
void log_ACTIVITY_HI_ShellCommandSucceeded (const Fw::StringBase &command)
 
void log_ACTIVITY_HI_CreateDirectorySucceeded (const Fw::StringBase &dirName)
 
void log_ACTIVITY_HI_RemoveDirectorySucceeded (const Fw::StringBase &dirName)
 
void log_ACTIVITY_HI_MoveFileSucceeded (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_ACTIVITY_HI_RemoveFileSucceeded (const Fw::StringBase &fileName)
 
void log_ACTIVITY_HI_AppendFileStarted (const Fw::StringBase &source, const Fw::StringBase &target)
 
void log_ACTIVITY_HI_ShellCommandStarted (const Fw::StringBase &command)
 
void log_ACTIVITY_HI_CreateDirectoryStarted (const Fw::StringBase &dirName)
 
void log_ACTIVITY_HI_RemoveDirectoryStarted (const Fw::StringBase &dirName)
 
void log_ACTIVITY_HI_MoveFileStarted (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_ACTIVITY_HI_RemoveFileStarted (const Fw::StringBase &fileName)
 
void log_ACTIVITY_HI_FileSizeSucceeded (const Fw::StringBase &fileName, U64 size)
 
void log_WARNING_HI_FileSizeError (const Fw::StringBase &fileName, U32 status)
 
void log_ACTIVITY_HI_FileSizeStarted (const Fw::StringBase &fileName)
 
void tlmWrite_CommandsExecuted (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Errors (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
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...
 
- 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...
 

Detailed Description

Definition at line 21 of file FileManager.hpp.

Constructor & Destructor Documentation

◆ FileManager()

Svc::FileManager::FileManager ( const char *const  compName)

Construct object FileManager

Parameters
compNameThe component name

Definition at line 26 of file FileManager.cpp.

◆ ~FileManager()

Svc::FileManager::~FileManager ( )

Destroy object FileManager

Definition at line 37 of file FileManager.cpp.


The documentation for this class was generated from the following files: