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

Auto-generated base for FileManager component. More...

#include <Svc/FileManager/FileManagerComponentAc.hpp>

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

Public Member Functions

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
 

Protected Types

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

 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 () const
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor. More...
 
virtual ~ActiveComponentBase ()
 Destructor. More...
 
void init (FwEnumStoreType 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 (FwEnumStoreType instance)
 initialization function More...
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
FwSizeType 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 (FwEnumStoreType instance)
 Initialization function. More...
 
FwEnumStoreType 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...
 
class FileManagerTesterBase
 Friend class tester to support autocoded test harness. 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...
 

Detailed Description

Auto-generated base for FileManager component.

A component for managing files

Definition at line 36 of file FileManagerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS 

Definition at line 56 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PINGIN_INPUT_PORTS 

Definition at line 61 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
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 66 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS 

Definition at line 76 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Command opcodes.

Enumerator
OPCODE_CREATEDIRECTORY 

Create a directory.

OPCODE_MOVEFILE 

Move a file.

OPCODE_REMOVEDIRECTORY 

Remove a directory, which must be empty.

OPCODE_REMOVEFILE 

Remove a file.

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.

OPCODE_FILESIZE 

Definition at line 81 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_DIRECTORYCREATEERROR 

An error occurred while attempting to create a directory.

EVENTID_DIRECTORYREMOVEERROR 

An error occurred while attempting to remove a directory.

EVENTID_FILEMOVEERROR 

An error occurred while attempting to move a file.

EVENTID_FILEREMOVEERROR 

An error occurred while attempting to remove a file.

EVENTID_SHELLCOMMANDFAILED 

The File System component executed a shell command that returned status non-zero.

EVENTID_APPENDFILEFAILED 

The File System component returned status non-zero when trying to append 2 files together.

EVENTID_APPENDFILESUCCEEDED 

The File System component appended 2 files without error.

EVENTID_SHELLCOMMANDSUCCEEDED 

The File System component executed a shell command that returned status zero.

EVENTID_CREATEDIRECTORYSUCCEEDED 

The File System component created a new directory without error.

EVENTID_REMOVEDIRECTORYSUCCEEDED 

The File System component deleted and existing directory without error.

EVENTID_MOVEFILESUCCEEDED 

The File System component moved a file to a new location without error.

EVENTID_REMOVEFILESUCCEEDED 

The File System component deleted an existing file without error.

EVENTID_APPENDFILESTARTED 

The File System component appended 2 files without error.

EVENTID_SHELLCOMMANDSTARTED 

The File System component began executing a shell command.

EVENTID_CREATEDIRECTORYSTARTED 

The File System component began creating a new directory.

EVENTID_REMOVEDIRECTORYSTARTED 

The File System component began deleting a directory.

EVENTID_MOVEFILESTARTED 

The File System component began moving a file to a new location.

EVENTID_REMOVEFILESTARTED 

The File System component began deleting an existing file.

EVENTID_FILESIZESUCCEEDED 

File size response.

EVENTID_FILESIZEERROR 

Failed to get file size.

EVENTID_FILESIZESTARTED 

Checking file size.

Definition at line 92 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_COMMANDSEXECUTED 

Channel ID for CommandsExecuted.

CHANNELID_ERRORS 

Channel ID for Errors.

Definition at line 117 of file FileManagerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FileManagerComponentBase()

Svc::FileManagerComponentBase::FileManagerComponentBase ( const char *  compName = "")
protected

Construct FileManagerComponentBase object.

Parameters
compNameThe component name

Definition at line 580 of file FileManagerComponentAc.cpp.

◆ ~FileManagerComponentBase()

Svc::FileManagerComponentBase::~FileManagerComponentBase ( )
protectedvirtual

Destroy FileManagerComponentBase object.

Definition at line 587 of file FileManagerComponentAc.cpp.

Member Function Documentation

◆ AppendFile_cmdHandler()

virtual void Svc::FileManagerComponentBase::AppendFile_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg source,
const Fw::CmdStringArg target 
)
protectedpure virtual

Handler for command AppendFile

Append 1 file's contents to the end of another.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
sourceThe name of the file to take content from
targetThe name of the file to append to

◆ AppendFile_cmdHandlerBase()

void Svc::FileManagerComponentBase::AppendFile_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command AppendFile

Append 1 file's contents to the end of another.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1172 of file FileManagerComponentAc.cpp.

◆ AppendFile_preMsgHook()

void Svc::FileManagerComponentBase::AppendFile_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command AppendFile.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1353 of file FileManagerComponentAc.cpp.

◆ cmdResponse_out()

void Svc::FileManagerComponentBase::cmdResponse_out ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdResponse  response 
)
protected

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 860 of file FileManagerComponentAc.cpp.

◆ CreateDirectory_cmdHandler()

virtual void Svc::FileManagerComponentBase::CreateDirectory_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg dirName 
)
protectedpure virtual

Handler for command CreateDirectory

Create a directory

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
dirNameThe directory to create

◆ CreateDirectory_cmdHandlerBase()

void Svc::FileManagerComponentBase::CreateDirectory_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CreateDirectory

Create a directory

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 877 of file FileManagerComponentAc.cpp.

◆ CreateDirectory_preMsgHook()

void Svc::FileManagerComponentBase::CreateDirectory_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CreateDirectory.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1298 of file FileManagerComponentAc.cpp.

◆ FileSize_cmdHandler()

virtual void Svc::FileManagerComponentBase::FileSize_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg fileName 
)
protectedpure virtual

Handler for command FileSize.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
fileNameThe file to get the size of

◆ FileSize_cmdHandlerBase()

void Svc::FileManagerComponentBase::FileSize_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command FileSize.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1231 of file FileManagerComponentAc.cpp.

◆ FileSize_preMsgHook()

void Svc::FileManagerComponentBase::FileSize_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command FileSize.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1364 of file FileManagerComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::FileManagerComponentBase::get_cmdIn_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
cmdIn[portNum]
Parameters
portNumThe port number

Definition at line 284 of file FileManagerComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::FileManagerComponentBase::get_pingIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
pingIn[portNum]
Parameters
portNumThe port number

Definition at line 299 of file FileManagerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_cmdIn_InputPorts ( ) const
protected

Get the number of cmdIn input ports

Returns
The number of cmdIn input ports

Definition at line 597 of file FileManagerComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const
protected

Get the number of cmdRegOut output ports

Returns
The number of cmdRegOut output ports

Definition at line 627 of file FileManagerComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const
protected

Get the number of cmdResponseOut output ports

Returns
The number of cmdResponseOut output ports

Definition at line 633 of file FileManagerComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_eventOut_OutputPorts ( ) const
protected

Get the number of eventOut output ports

Returns
The number of eventOut output ports

Definition at line 639 of file FileManagerComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_pingIn_InputPorts ( ) const
protected

Get the number of pingIn input ports

Returns
The number of pingIn input ports

Definition at line 607 of file FileManagerComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_pingOut_OutputPorts ( ) const
protected

Get the number of pingOut output ports

Returns
The number of pingOut output ports

Definition at line 661 of file FileManagerComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_timeCaller_OutputPorts ( ) const
protected

Get the number of timeCaller output ports

Returns
The number of timeCaller output ports

Definition at line 645 of file FileManagerComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::FileManagerComponentBase::getNum_tlmOut_OutputPorts ( ) const
protected

Get the number of tlmOut output ports

Returns
The number of tlmOut output ports

Definition at line 651 of file FileManagerComponentAc.cpp.

◆ getTime()

Fw::Time Svc::FileManagerComponentBase::getTime ( ) const
protected

Get the time

\return The current time

Definition at line 3181 of file FileManagerComponentAc.cpp.

◆ init()

void Svc::FileManagerComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize FileManagerComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 77 of file FileManagerComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdRegOut is connected

Returns
Whether port cmdRegOut is connected
Parameters
portNumThe port number

Definition at line 686 of file FileManagerComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdResponseOut is connected

Returns
Whether port cmdResponseOut is connected
Parameters
portNumThe port number

Definition at line 697 of file FileManagerComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_eventOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port eventOut is connected

Returns
Whether port eventOut is connected
Parameters
portNumThe port number

Definition at line 708 of file FileManagerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port pingOut is connected

Returns
Whether port pingOut is connected
Parameters
portNumThe port number

Definition at line 745 of file FileManagerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum)
protected

Check whether port timeCaller is connected

Returns
Whether port timeCaller is connected
Parameters
portNumThe port number

Definition at line 719 of file FileManagerComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port tlmOut is connected

Returns
Whether port tlmOut is connected
Parameters
portNumThe port number

Definition at line 730 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_AppendFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_AppendFileStarted ( const Fw::StringBase source,
const Fw::StringBase target 
) const
protected

Log event AppendFileStarted

The File System component appended 2 files without error

Parameters
sourceThe name of the file being read from
targetThe name of the file to append to

Definition at line 2399 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_AppendFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_AppendFileSucceeded ( const Fw::StringBase source,
const Fw::StringBase target 
) const
protected

Log event AppendFileSucceeded

The File System component appended 2 files without error

Parameters
sourceThe name of the file being read from
targetThe name of the file to append to

Definition at line 1947 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_CreateDirectoryStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_CreateDirectoryStarted ( const Fw::StringBase dirName) const
protected

Log event CreateDirectoryStarted

The File System component began creating a new directory

Parameters
dirNameThe name of the directory

Definition at line 2553 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_CreateDirectorySucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_CreateDirectorySucceeded ( const Fw::StringBase dirName) const
protected

Log event CreateDirectorySucceeded

The File System component created a new directory without error

Parameters
dirNameThe name of the directory

Definition at line 2101 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_FileSizeStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_FileSizeStarted ( const Fw::StringBase fileName) const
protected

Log event FileSizeStarted

Checking file size

Parameters
fileNameThe name of the file

Definition at line 3035 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_FileSizeSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_FileSizeSucceeded ( const Fw::StringBase fileName,
U64  size 
) const
protected

Log event FileSizeSucceeded

File size response

Parameters
fileNameThe name of the file
sizeThe size of the file in bytes

Definition at line 2851 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_MoveFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_MoveFileStarted ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
) const
protected

Log event MoveFileStarted

The File System component began moving a file to a new location

Parameters
sourceFileNameThe name of the source file
destFileNameThe name of the destination file

Definition at line 2697 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_MoveFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_MoveFileSucceeded ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
) const
protected

Log event MoveFileSucceeded

The File System component moved a file to a new location without error

Parameters
sourceFileNameThe name of the source file
destFileNameThe name of the destination file

Definition at line 2245 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_RemoveDirectoryStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveDirectoryStarted ( const Fw::StringBase dirName) const
protected

Log event RemoveDirectoryStarted

The File System component began deleting a directory

Parameters
dirNameThe name of the directory

Definition at line 2625 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_RemoveDirectorySucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveDirectorySucceeded ( const Fw::StringBase dirName) const
protected

Log event RemoveDirectorySucceeded

The File System component deleted and existing directory without error

Parameters
dirNameThe name of the directory

Definition at line 2173 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_RemoveFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveFileStarted ( const Fw::StringBase fileName) const
protected

Log event RemoveFileStarted

The File System component began deleting an existing file

Parameters
fileNameThe name of the file

Definition at line 2779 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_RemoveFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveFileSucceeded ( const Fw::StringBase fileName) const
protected

Log event RemoveFileSucceeded

The File System component deleted an existing file without error

Parameters
fileNameThe name of the file

Definition at line 2327 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ShellCommandStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ShellCommandStarted ( const Fw::StringBase command) const
protected

Log event ShellCommandStarted

The File System component began executing a shell command

Parameters
commandThe command string

Definition at line 2481 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ShellCommandSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ShellCommandSucceeded ( const Fw::StringBase command) const
protected

Log event ShellCommandSucceeded

The File System component executed a shell command that returned status zero

Parameters
commandThe command string

Definition at line 2029 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_AppendFileFailed()

void Svc::FileManagerComponentBase::log_WARNING_HI_AppendFileFailed ( const Fw::StringBase source,
const Fw::StringBase target,
U32  status 
) const
protected

Log event AppendFileFailed

The File System component returned status non-zero when trying to append 2 files together

Parameters
sourceThe name of the file being read from
targetThe name of the file to append to
statusThe error status

Definition at line 1847 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_DirectoryCreateError()

void Svc::FileManagerComponentBase::log_WARNING_HI_DirectoryCreateError ( const Fw::StringBase dirName,
U32  status 
) const
protected

Log event DirectoryCreateError

An error occurred while attempting to create a directory

Parameters
dirNameThe name of the directory
statusThe error status

Definition at line 1379 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_DirectoryRemoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_DirectoryRemoveError ( const Fw::StringBase dirName,
U32  status 
) const
protected

Log event DirectoryRemoveError

An error occurred while attempting to remove a directory

Parameters
dirNameThe name of the directory
statusThe error status

Definition at line 1471 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_FileMoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileMoveError ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName,
U32  status 
) const
protected

Log event FileMoveError

An error occurred while attempting to move a file

Parameters
sourceFileNameThe name of the source file
destFileNameThe name of the destination file
statusThe error status

Definition at line 1563 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_FileRemoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileRemoveError ( const Fw::StringBase fileName,
U32  status 
) const
protected

Log event FileRemoveError

An error occurred while attempting to remove a file

Parameters
fileNameThe name of the file
statusThe error status

Definition at line 1663 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_FileSizeError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileSizeError ( const Fw::StringBase fileName,
U32  status 
) const
protected

Log event FileSizeError

Failed to get file size

Parameters
fileNameThe name of the file
statusThe error status

Definition at line 2943 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_ShellCommandFailed()

void Svc::FileManagerComponentBase::log_WARNING_HI_ShellCommandFailed ( const Fw::StringBase command,
U32  status 
) const
protected

Log event ShellCommandFailed

The File System component executed a shell command that returned status non-zero

Parameters
commandThe command string
statusThe status code

Definition at line 1755 of file FileManagerComponentAc.cpp.

◆ MoveFile_cmdHandler()

virtual void Svc::FileManagerComponentBase::MoveFile_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg sourceFileName,
const Fw::CmdStringArg destFileName 
)
protectedpure virtual

Handler for command MoveFile

Move a file

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
sourceFileNameThe source file name
destFileNameThe destination file name

◆ MoveFile_cmdHandlerBase()

void Svc::FileManagerComponentBase::MoveFile_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command MoveFile

Move a file

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 936 of file FileManagerComponentAc.cpp.

◆ MoveFile_preMsgHook()

void Svc::FileManagerComponentBase::MoveFile_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command MoveFile.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1309 of file FileManagerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::FileManagerComponentBase::pingIn_handler ( FwIndexType  portNum,
U32  key 
)
protectedpure virtual

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

◆ pingIn_handlerBase()

void Svc::FileManagerComponentBase::pingIn_handlerBase ( FwIndexType  portNum,
U32  key 
)
protected

Handler base-class function for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 762 of file FileManagerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::FileManagerComponentBase::pingIn_preMsgHook ( FwIndexType  portNum,
U32  key 
)
protectedvirtual

Pre-message hook for async input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 823 of file FileManagerComponentAc.cpp.

◆ pingOut_out()

void Svc::FileManagerComponentBase::pingOut_out ( FwIndexType  portNum,
U32  key 
)
protected

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 836 of file FileManagerComponentAc.cpp.

◆ regCommands()

void Svc::FileManagerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 542 of file FileManagerComponentAc.cpp.

◆ RemoveDirectory_cmdHandler()

virtual void Svc::FileManagerComponentBase::RemoveDirectory_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg dirName 
)
protectedpure virtual

Handler for command RemoveDirectory

Remove a directory, which must be empty

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
dirNameThe directory to remove

◆ RemoveDirectory_cmdHandlerBase()

void Svc::FileManagerComponentBase::RemoveDirectory_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command RemoveDirectory

Remove a directory, which must be empty

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 995 of file FileManagerComponentAc.cpp.

◆ RemoveDirectory_preMsgHook()

void Svc::FileManagerComponentBase::RemoveDirectory_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command RemoveDirectory.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1320 of file FileManagerComponentAc.cpp.

◆ RemoveFile_cmdHandler()

virtual void Svc::FileManagerComponentBase::RemoveFile_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg fileName,
bool  ignoreErrors 
)
protectedpure virtual

Handler for command RemoveFile

Remove a file

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
fileNameThe file to remove
ignoreErrorsIgnore nonexistent files

◆ RemoveFile_cmdHandlerBase()

void Svc::FileManagerComponentBase::RemoveFile_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command RemoveFile

Remove a file

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1054 of file FileManagerComponentAc.cpp.

◆ RemoveFile_preMsgHook()

void Svc::FileManagerComponentBase::RemoveFile_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command RemoveFile.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1331 of file FileManagerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::FileManagerComponentBase::set_cmdRegOut_OutputPort ( FwIndexType  portNum,
Fw::InputCmdRegPort port 
)

Connect port to cmdRegOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 332 of file FileManagerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::FileManagerComponentBase::set_cmdResponseOut_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to cmdResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 346 of file FileManagerComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::FileManagerComponentBase::set_eventOut_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to eventOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 360 of file FileManagerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::FileManagerComponentBase::set_pingOut_OutputPort ( FwIndexType  portNum,
Svc::InputPingPort port 
)

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 406 of file FileManagerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::FileManagerComponentBase::set_timeCaller_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 374 of file FileManagerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::FileManagerComponentBase::set_tlmOut_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 388 of file FileManagerComponentAc.cpp.

◆ ShellCommand_cmdHandler()

virtual void Svc::FileManagerComponentBase::ShellCommand_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg command,
const Fw::CmdStringArg logFileName 
)
protectedpure virtual

Handler for command ShellCommand

Perform a Linux shell command and write the output to a log file.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
commandThe shell command string
logFileNameThe name of the log file

◆ ShellCommand_cmdHandlerBase()

void Svc::FileManagerComponentBase::ShellCommand_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command ShellCommand

Perform a Linux shell command and write the output to a log file.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1113 of file FileManagerComponentAc.cpp.

◆ ShellCommand_preMsgHook()

void Svc::FileManagerComponentBase::ShellCommand_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command ShellCommand.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1342 of file FileManagerComponentAc.cpp.

◆ tlmWrite_CommandsExecuted()

void Svc::FileManagerComponentBase::tlmWrite_CommandsExecuted ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel CommandsExecuted

The total number of commands successfully executed

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 3111 of file FileManagerComponentAc.cpp.

◆ tlmWrite_Errors()

void Svc::FileManagerComponentBase::tlmWrite_Errors ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel Errors

The total number of errors

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 3144 of file FileManagerComponentAc.cpp.

Friends And Related Function Documentation

◆ FileManagerComponentBaseFriend

friend class FileManagerComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 45 of file FileManagerComponentAc.hpp.

◆ FileManagerTesterBase

friend class FileManagerTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 47 of file FileManagerComponentAc.hpp.


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