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

#include <Svc/FileManager/FileManagerComponentAc.hpp>

Inheritance diagram for Svc::FileManagerComponentBase:

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)

Svc::InputSchedPort *	get_schedIn_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 (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(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 FwIdType)
	Set the ID base. More...

FwIdType	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_PINGIN_INPUT_PORTS = 1, NUM_SCHEDIN_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, OPCODE_LISTDIRECTORY = 0x7 }
	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, EVENTID_LISTDIRECTORYSTARTED = 0x15, EVENTID_LISTDIRECTORYSUCCEEDED = 0x16, EVENTID_LISTDIRECTORYERROR = 0x17, EVENTID_DIRECTORYLISTING = 0x18, EVENTID_DIRECTORYLISTINGSUBDIR = 0x19 }
	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...

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...

virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn. More...

void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...

void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn. More...

virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

virtual void	schedIn_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port schedIn. 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...

virtual void	ListDirectory_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &dirName)=0

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...

void	ListDirectory_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

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...

virtual void	ListDirectory_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command ListDirectory. 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, FwSizeType 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	log_ACTIVITY_HI_ListDirectoryStarted (const Fw::StringBase &dirName) const

void	log_ACTIVITY_HI_ListDirectorySucceeded (const Fw::StringBase &dirName, U32 fileCount) const

void	log_WARNING_HI_ListDirectoryError (const Fw::StringBase &dirName, U32 status) const

void	log_ACTIVITY_HI_DirectoryListing (const Fw::StringBase &dirName, const Fw::StringBase &fileName, FwSizeType fileSize) const

void	log_ACTIVITY_HI_DirectoryListingSubdir (const Fw::StringBase &dirName, const Fw::StringBase &subdirName) 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...

Static Protected Member Functions
static constexpr FwIndexType	getNum_cmdIn_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_schedIn_InputPorts ()

static constexpr FwIndexType	getNum_cmdRegOut_OutputPorts ()

static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()

static constexpr FwIndexType	getNum_eventOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_tlmOut_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

Friends
class	FileManagerTesterBase
	Friend class tester to support autocoded test harness. More...

class	FileManagerTester
	Friend class tester implementation to support 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...

Detailed Description

Auto-generated base for FileManager component.

A component for managing files

Definition at line 38 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 58 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PINGIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 63 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 69 of file FileManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 79 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
OPCODE_LISTDIRECTORY	List the contents of a directory.

Definition at line 84 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.
EVENTID_LISTDIRECTORYSTARTED	Starting directory listing.
EVENTID_LISTDIRECTORYSUCCEEDED	Directory listing completed successfully.
EVENTID_LISTDIRECTORYERROR	Failed to list directory.
EVENTID_DIRECTORYLISTING	Directory listing file entry.
EVENTID_DIRECTORYLISTINGSUBDIR	Directory listing subdirectory entry.

Definition at line 96 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 126 of file FileManagerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FileManagerComponentBase()

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

protected

Construct FileManagerComponentBase object.

Parameters

compName The component name

Definition at line 622 of file FileManagerComponentAc.cpp.

◆ ~FileManagerComponentBase()

Svc::FileManagerComponentBase::~FileManagerComponentBase ( )

protectedvirtual

Destroy FileManagerComponentBase object.

Definition at line 629 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

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

◆ 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1202 of file FileManagerComponentAc.cpp.

◆ AppendFile_preMsgHook()

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

protectedvirtual

Pre-message hook for command AppendFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1442 of file FileManagerComponentAc.cpp.

◆ cmdResponse_out()

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

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 890 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

opCode	The opcode
cmdSeq	The command sequence number
dirName	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 907 of file FileManagerComponentAc.cpp.

◆ CreateDirectory_preMsgHook()

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

protectedvirtual

Pre-message hook for command CreateDirectory.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1387 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

opCode	The opcode
cmdSeq	The command sequence number
fileName	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1261 of file FileManagerComponentAc.cpp.

◆ FileSize_preMsgHook()

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

protectedvirtual

Pre-message hook for command FileSize.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1453 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

portNum The port number

Definition at line 311 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

portNum The port number

Definition at line 326 of file FileManagerComponentAc.cpp.

◆ get_schedIn_InputPort()

Svc::InputSchedPort * Svc::FileManagerComponentBase::get_schedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: schedIn[portNum]

Parameters

portNum The port number

Definition at line 337 of file FileManagerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_cmdIn_InputPorts ( )

inlinestaticprotected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 334 of file FileManagerComponentAc.hpp.

◆ getNum_cmdRegOut_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_cmdRegOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 378 of file FileManagerComponentAc.hpp.

◆ getNum_cmdResponseOut_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_cmdResponseOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 385 of file FileManagerComponentAc.hpp.

◆ getNum_eventOut_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_eventOut_OutputPorts ( )

inlinestaticprotected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 392 of file FileManagerComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_pingIn_InputPorts ( )

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 347 of file FileManagerComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_pingOut_OutputPorts ( )

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 419 of file FileManagerComponentAc.hpp.

◆ getNum_schedIn_InputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_schedIn_InputPorts ( )

inlinestaticprotected

Get the number of schedIn input ports

Returns: The number of schedIn input ports

Definition at line 354 of file FileManagerComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 399 of file FileManagerComponentAc.hpp.

◆ getNum_tlmOut_OutputPorts()

static constexpr FwIndexType Svc::FileManagerComponentBase::getNum_tlmOut_OutputPorts ( )

inlinestaticprotected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 406 of file FileManagerComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 3719 of file FileManagerComponentAc.cpp.

◆ init()

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

Initialize FileManagerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 80 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

portNum The port number

Definition at line 654 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

portNum The port number

Definition at line 665 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

portNum The port number

Definition at line 676 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

portNum The port number

Definition at line 713 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

portNum The port number

Definition at line 687 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

portNum The port number

Definition at line 698 of file FileManagerComponentAc.cpp.

◆ ListDirectory_cmdHandler()

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

protectedpure virtual

Handler for command ListDirectory

List the contents of a directory

Parameters

opCode	The opcode
cmdSeq	The command sequence number
dirName	The directory to list

◆ ListDirectory_cmdHandlerBase()

void Svc::FileManagerComponentBase::ListDirectory_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command ListDirectory

List the contents of a directory

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1320 of file FileManagerComponentAc.cpp.

◆ ListDirectory_preMsgHook()

void Svc::FileManagerComponentBase::ListDirectory_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command ListDirectory.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1464 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

source	The name of the file being read from
target	The name of the file to append to

Definition at line 2499 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

source	The name of the file being read from
target	The name of the file to append to

Definition at line 2047 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

dirName The name of the directory

Definition at line 2653 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

dirName The name of the directory

Definition at line 2201 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_DirectoryListing()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_DirectoryListing	(	const Fw::StringBase &	dirName,
		const Fw::StringBase &	fileName,
		FwSizeType	fileSize
	)		const

protected

Log event DirectoryListing

Directory listing file entry

Parameters

dirName	The name of the directory
fileName	The name of the file
fileSize	The size of the file in bytes

Definition at line 3463 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_DirectoryListingSubdir()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_DirectoryListingSubdir	(	const Fw::StringBase &	dirName,
		const Fw::StringBase &	subdirName
	)		const

protected

Log event DirectoryListingSubdir

Directory listing subdirectory entry

Parameters

dirName	The name of the directory
subdirName	The name of the subdirectory

Definition at line 3563 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

fileName The name of the file

Definition at line 3135 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_FileSizeSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_FileSizeSucceeded	(	const Fw::StringBase &	fileName,
		FwSizeType	size
	)		const

protected

Log event FileSizeSucceeded

File size response

Parameters

fileName	The name of the file
size	The size of the file in bytes

Definition at line 2951 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ListDirectoryStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ListDirectoryStarted ( const Fw::StringBase & dirName ) const

protected

Log event ListDirectoryStarted

Starting directory listing

Parameters

dirName The name of the directory

Definition at line 3207 of file FileManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ListDirectorySucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ListDirectorySucceeded	(	const Fw::StringBase &	dirName,
		U32	fileCount
	)		const

protected

Log event ListDirectorySucceeded

Directory listing completed successfully

Parameters

dirName	The name of the directory
fileCount	The number of files found

Definition at line 3279 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

sourceFileName	The name of the source file
destFileName	The name of the destination file

Definition at line 2797 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

sourceFileName	The name of the source file
destFileName	The name of the destination file

Definition at line 2345 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

dirName The name of the directory

Definition at line 2725 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

dirName The name of the directory

Definition at line 2273 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

fileName The name of the file

Definition at line 2879 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

fileName The name of the file

Definition at line 2427 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

command The command string

Definition at line 2581 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

command The command string

Definition at line 2129 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

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 1947 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

dirName	The name of the directory
status	The error status

Definition at line 1479 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

dirName	The name of the directory
status	The error status

Definition at line 1571 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

sourceFileName	The name of the source file
destFileName	The name of the destination file
status	The error status

Definition at line 1663 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

fileName	The name of the file
status	The error status

Definition at line 1763 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

fileName	The name of the file
status	The error status

Definition at line 3043 of file FileManagerComponentAc.cpp.

◆ log_WARNING_HI_ListDirectoryError()

void Svc::FileManagerComponentBase::log_WARNING_HI_ListDirectoryError	(	const Fw::StringBase &	dirName,
		U32	status
	)		const

protected

Log event ListDirectoryError

Failed to list directory

Parameters

dirName	The name of the directory
status	The error status

Definition at line 3371 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

command	The command string
status	The status code

Definition at line 1855 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

opCode	The opcode
cmdSeq	The command sequence number
sourceFileName	The source file name
destFileName	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 966 of file FileManagerComponentAc.cpp.

◆ MoveFile_preMsgHook()

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

protectedvirtual

Pre-message hook for command MoveFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1398 of file FileManagerComponentAc.cpp.

◆ pingIn_handler()

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

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value 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

portNum	The port number
key	Value to return to pinger

Definition at line 730 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

portNum	The port number
key	Value to return to pinger

Definition at line 844 of file FileManagerComponentAc.cpp.

◆ pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 866 of file FileManagerComponentAc.cpp.

◆ regCommands()

void Svc::FileManagerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 580 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

opCode	The opcode
cmdSeq	The command sequence number
dirName	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1025 of file FileManagerComponentAc.cpp.

◆ RemoveDirectory_preMsgHook()

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

protectedvirtual

Pre-message hook for command RemoveDirectory.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1409 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

opCode	The opcode
cmdSeq	The command sequence number
fileName	The file to remove
ignoreErrors	Ignore 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1084 of file FileManagerComponentAc.cpp.

◆ RemoveFile_preMsgHook()

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

protectedvirtual

Pre-message hook for command RemoveFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1420 of file FileManagerComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::FileManagerComponentBase::schedIn_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

◆ schedIn_handlerBase()

void Svc::FileManagerComponentBase::schedIn_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 783 of file FileManagerComponentAc.cpp.

◆ schedIn_preMsgHook()

void Svc::FileManagerComponentBase::schedIn_preMsgHook	(	FwIndexType	portNum,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 853 of file FileManagerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

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

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 370 of file FileManagerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 384 of file FileManagerComponentAc.cpp.

◆ set_eventOut_OutputPort()

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

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 398 of file FileManagerComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 444 of file FileManagerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 412 of file FileManagerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 426 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

opCode	The opcode
cmdSeq	The command sequence number
command	The shell command string
logFileName	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1143 of file FileManagerComponentAc.cpp.

◆ ShellCommand_preMsgHook()

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

protectedvirtual

Pre-message hook for command ShellCommand.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1431 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

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 3649 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

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 3682 of file FileManagerComponentAc.cpp.

Friends And Related Function Documentation

◆ FileManagerTester

friend class FileManagerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 49 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:

Svc/FileManager/FileManagerComponentAc.hpp
Svc/FileManager/FileManagerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FileManagerComponentBase()

◆ ~FileManagerComponentBase()

Member Function Documentation

◆ AppendFile_cmdHandler()

◆ AppendFile_cmdHandlerBase()

◆ AppendFile_preMsgHook()

◆ cmdResponse_out()

◆ CreateDirectory_cmdHandler()

◆ CreateDirectory_cmdHandlerBase()

◆ CreateDirectory_preMsgHook()

◆ FileSize_cmdHandler()

◆ FileSize_cmdHandlerBase()

◆ FileSize_preMsgHook()

◆ get_cmdIn_InputPort()

◆ get_pingIn_InputPort()

◆ get_schedIn_InputPort()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_schedIn_InputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ ListDirectory_cmdHandler()

◆ ListDirectory_cmdHandlerBase()

◆ ListDirectory_preMsgHook()

◆ log_ACTIVITY_HI_AppendFileStarted()

◆ log_ACTIVITY_HI_AppendFileSucceeded()

◆ log_ACTIVITY_HI_CreateDirectoryStarted()

◆ log_ACTIVITY_HI_CreateDirectorySucceeded()

◆ log_ACTIVITY_HI_DirectoryListing()

◆ log_ACTIVITY_HI_DirectoryListingSubdir()

◆ log_ACTIVITY_HI_FileSizeStarted()

◆ log_ACTIVITY_HI_FileSizeSucceeded()

◆ log_ACTIVITY_HI_ListDirectoryStarted()

◆ log_ACTIVITY_HI_ListDirectorySucceeded()

◆ log_ACTIVITY_HI_MoveFileStarted()

◆ log_ACTIVITY_HI_MoveFileSucceeded()

◆ log_ACTIVITY_HI_RemoveDirectoryStarted()

◆ log_ACTIVITY_HI_RemoveDirectorySucceeded()

◆ log_ACTIVITY_HI_RemoveFileStarted()

◆ log_ACTIVITY_HI_RemoveFileSucceeded()

◆ log_ACTIVITY_HI_ShellCommandStarted()

◆ log_ACTIVITY_HI_ShellCommandSucceeded()

◆ log_WARNING_HI_AppendFileFailed()

◆ log_WARNING_HI_DirectoryCreateError()

◆ log_WARNING_HI_DirectoryRemoveError()

◆ log_WARNING_HI_FileMoveError()

◆ log_WARNING_HI_FileRemoveError()

◆ log_WARNING_HI_FileSizeError()

◆ log_WARNING_HI_ListDirectoryError()

◆ log_WARNING_HI_ShellCommandFailed()

◆ MoveFile_cmdHandler()

◆ MoveFile_cmdHandlerBase()