Svc::FileManagerComponentBase Class Reference

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

#include <docs-cache/F-Prime/Svc/FileManager/FileManagerComponentAc.hpp>

Inheritance diagram for Svc::FileManagerComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize FileManagerComponentBase object.
Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)
void	set_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum].
void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum].
void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum].
void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum].
void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum].
void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum].
void	regCommands ()
	Register commands with the Command Dispatcher.
Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started
	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started
void	exit ()
	exit task in active component
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
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 Member Functions
	FileManagerComponentBase (const char *compName="")
	Construct FileManagerComponentBase object.
virtual	~FileManagerComponentBase ()
	Destroy FileManagerComponentBase object.
NATIVE_INT_TYPE	getNum_cmdIn_InputPorts ()
NATIVE_INT_TYPE	getNum_pingIn_InputPorts ()
NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_eventOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts ()
NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_pingOut_OutputPorts ()
bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
virtual void	pingIn_handler (NATIVE_INT_TYPE portNum, U32 key)=0
	Handler for input port pingIn.
void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn.
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn.
void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port pingOut.
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response.
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.
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.
virtual void	CreateDirectory_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CreateDirectory.
virtual void	MoveFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command MoveFile.
virtual void	RemoveDirectory_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command RemoveDirectory.
virtual void	RemoveFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command RemoveFile.
virtual void	ShellCommand_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command ShellCommand.
virtual void	AppendFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command AppendFile.
virtual void	FileSize_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command FileSize.
void	log_WARNING_HI_DirectoryCreateError (const Fw::LogStringArg &dirName, U32 status)
void	log_WARNING_HI_DirectoryRemoveError (const Fw::LogStringArg &dirName, U32 status)
void	log_WARNING_HI_FileMoveError (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName, U32 status)
void	log_WARNING_HI_FileRemoveError (const Fw::LogStringArg &fileName, U32 status)
void	log_WARNING_HI_ShellCommandFailed (const Fw::LogStringArg &command, U32 status)
void	log_WARNING_HI_AppendFileFailed (const Fw::LogStringArg &source, const Fw::LogStringArg &target, U32 status)
void	log_ACTIVITY_HI_AppendFileSucceeded (const Fw::LogStringArg &source, const Fw::LogStringArg &target)
void	log_ACTIVITY_HI_ShellCommandSucceeded (const Fw::LogStringArg &command)
void	log_ACTIVITY_HI_CreateDirectorySucceeded (const Fw::LogStringArg &dirName)
void	log_ACTIVITY_HI_RemoveDirectorySucceeded (const Fw::LogStringArg &dirName)
void	log_ACTIVITY_HI_MoveFileSucceeded (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_ACTIVITY_HI_RemoveFileSucceeded (const Fw::LogStringArg &fileName)
void	log_ACTIVITY_HI_AppendFileStarted (const Fw::LogStringArg &source, const Fw::LogStringArg &target)
void	log_ACTIVITY_HI_ShellCommandStarted (const Fw::LogStringArg &command)
void	log_ACTIVITY_HI_CreateDirectoryStarted (const Fw::LogStringArg &dirName)
void	log_ACTIVITY_HI_RemoveDirectoryStarted (const Fw::LogStringArg &dirName)
void	log_ACTIVITY_HI_MoveFileStarted (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_ACTIVITY_HI_RemoveFileStarted (const Fw::LogStringArg &fileName)
void	log_ACTIVITY_HI_FileSizeSucceeded (const Fw::LogStringArg &fileName, U64 size)
void	log_WARNING_HI_FileSizeError (const Fw::LogStringArg &fileName, U32 status)
void	log_ACTIVITY_HI_FileSizeStarted (const Fw::LogStringArg &fileName)
void	tlmWrite_CommandsExecuted (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_Errors (U32 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime ()
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor.
virtual	~ActiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization code
virtual void	preamble ()
	A function that will be called before the event loop is entered.
virtual void	loop ()
	The function that will loop dispatching messages.
virtual void	finalizer ()
	A function that will be called after exiting the loop.
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor.
virtual	~QueuedComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization function
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped
void	incNumMsgDropped ()
	increment the number of messages dropped
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.

Friends
class	FileManagerComponentBaseFriend
	Friend class for white-box testing.

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
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Auto-generated base for FileManager component.

A component for managing files

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

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PINGIN_INPUT_PORTS

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

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 72 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 77 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 88 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 113 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 595 of file FileManagerComponentAc.cpp.

~FileManagerComponentBase()

Svc::FileManagerComponentBase::~FileManagerComponentBase ( )

protectedvirtual

Destroy FileManagerComponentBase object.

Definition at line 602 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 1182 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 1353 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 870 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 887 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 1308 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 1241 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 1362 of file FileManagerComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::FileManagerComponentBase::get_cmdIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 299 of file FileManagerComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::FileManagerComponentBase::get_pingIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 314 of file FileManagerComponentAc.cpp.

getNum_cmdIn_InputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_cmdIn_InputPorts ( )

protected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 612 of file FileManagerComponentAc.cpp.

getNum_cmdRegOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_cmdRegOut_OutputPorts ( )

protected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 642 of file FileManagerComponentAc.cpp.

getNum_cmdResponseOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_cmdResponseOut_OutputPorts ( )

protected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 648 of file FileManagerComponentAc.cpp.

getNum_eventOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_eventOut_OutputPorts ( )

protected

Get the number of eventOut output ports

Returns

The number of eventOut output ports

Definition at line 654 of file FileManagerComponentAc.cpp.

getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_pingIn_InputPorts ( )

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 622 of file FileManagerComponentAc.cpp.

getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_pingOut_OutputPorts ( )

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 676 of file FileManagerComponentAc.cpp.

getNum_timeCaller_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_timeCaller_OutputPorts ( )

protected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 660 of file FileManagerComponentAc.cpp.

getNum_tlmOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileManagerComponentBase::getNum_tlmOut_OutputPorts ( )

protected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 666 of file FileManagerComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 3303 of file FileManagerComponentAc.cpp.

init()

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

Initialize FileManagerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 75 of file FileManagerComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_cmdRegOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdRegOut is connected

Returns

Whether port cmdRegOut is connected

Parameters

portNum

The port number

Definition at line 701 of file FileManagerComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_cmdResponseOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdResponseOut is connected

Returns

Whether port cmdResponseOut is connected

Parameters

portNum

The port number

Definition at line 712 of file FileManagerComponentAc.cpp.

isConnected_eventOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_eventOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port eventOut is connected

Returns

Whether port eventOut is connected

Parameters

portNum

The port number

Definition at line 723 of file FileManagerComponentAc.cpp.

isConnected_pingOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_pingOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port pingOut is connected

Returns

Whether port pingOut is connected

Parameters

portNum

The port number

Definition at line 760 of file FileManagerComponentAc.cpp.

isConnected_timeCaller_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_timeCaller_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port timeCaller is connected

Returns

Whether port timeCaller is connected

Parameters

portNum

The port number

Definition at line 734 of file FileManagerComponentAc.cpp.

isConnected_tlmOut_OutputPort()

bool Svc::FileManagerComponentBase::isConnected_tlmOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port tlmOut is connected

Returns

Whether port tlmOut is connected

Parameters

portNum

The port number

Definition at line 745 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_AppendFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_AppendFileStarted ( const Fw::LogStringArg & source, const Fw::LogStringArg & target )

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 2467 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_AppendFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_AppendFileSucceeded ( const Fw::LogStringArg & source, const Fw::LogStringArg & target )

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 1979 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_CreateDirectoryStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_CreateDirectoryStarted ( const Fw::LogStringArg & dirName )

protected

Log event CreateDirectoryStarted

The File System component began creating a new directory

Parameters

dirName

The name of the directory

Definition at line 2633 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_CreateDirectorySucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_CreateDirectorySucceeded ( const Fw::LogStringArg & dirName )

protected

Log event CreateDirectorySucceeded

The File System component created a new directory without error

Parameters

dirName

The name of the directory

Definition at line 2145 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_FileSizeStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_FileSizeStarted ( const Fw::LogStringArg & fileName )

protected

Log event FileSizeStarted

Checking file size

Parameters

fileName

The name of the file

Definition at line 3151 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_FileSizeSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_FileSizeSucceeded ( const Fw::LogStringArg & fileName, U64 size )

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 2955 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_MoveFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_MoveFileStarted ( const Fw::LogStringArg & sourceFileName, const Fw::LogStringArg & destFileName )

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 2789 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_MoveFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_MoveFileSucceeded ( const Fw::LogStringArg & sourceFileName, const Fw::LogStringArg & destFileName )

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 2301 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_RemoveDirectoryStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveDirectoryStarted ( const Fw::LogStringArg & dirName )

protected

Log event RemoveDirectoryStarted

The File System component began deleting a directory

Parameters

dirName

The name of the directory

Definition at line 2711 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_RemoveDirectorySucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveDirectorySucceeded ( const Fw::LogStringArg & dirName )

protected

Log event RemoveDirectorySucceeded

The File System component deleted and existing directory without error

Parameters

dirName

The name of the directory

Definition at line 2223 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_RemoveFileStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveFileStarted ( const Fw::LogStringArg & fileName )

protected

Log event RemoveFileStarted

The File System component began deleting an existing file

Parameters

fileName

The name of the file

Definition at line 2877 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_RemoveFileSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_RemoveFileSucceeded ( const Fw::LogStringArg & fileName )

protected

Log event RemoveFileSucceeded

The File System component deleted an existing file without error

Parameters

fileName

The name of the file

Definition at line 2389 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_ShellCommandStarted()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ShellCommandStarted ( const Fw::LogStringArg & command )

protected

Log event ShellCommandStarted

The File System component began executing a shell command

Parameters

command

The command string

Definition at line 2555 of file FileManagerComponentAc.cpp.

log_ACTIVITY_HI_ShellCommandSucceeded()

void Svc::FileManagerComponentBase::log_ACTIVITY_HI_ShellCommandSucceeded ( const Fw::LogStringArg & command )

protected

Log event ShellCommandSucceeded

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

Parameters

command

The command string

Definition at line 2067 of file FileManagerComponentAc.cpp.

log_WARNING_HI_AppendFileFailed()

void Svc::FileManagerComponentBase::log_WARNING_HI_AppendFileFailed ( const Fw::LogStringArg & source, const Fw::LogStringArg & target, U32 status )

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 1873 of file FileManagerComponentAc.cpp.

log_WARNING_HI_DirectoryCreateError()

void Svc::FileManagerComponentBase::log_WARNING_HI_DirectoryCreateError ( const Fw::LogStringArg & dirName, U32 status )

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 1375 of file FileManagerComponentAc.cpp.

log_WARNING_HI_DirectoryRemoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_DirectoryRemoveError ( const Fw::LogStringArg & dirName, U32 status )

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 1473 of file FileManagerComponentAc.cpp.

log_WARNING_HI_FileMoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileMoveError ( const Fw::LogStringArg & sourceFileName, const Fw::LogStringArg & destFileName, U32 status )

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 1571 of file FileManagerComponentAc.cpp.

log_WARNING_HI_FileRemoveError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileRemoveError ( const Fw::LogStringArg & fileName, U32 status )

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 1677 of file FileManagerComponentAc.cpp.

log_WARNING_HI_FileSizeError()

void Svc::FileManagerComponentBase::log_WARNING_HI_FileSizeError ( const Fw::LogStringArg & fileName, U32 status )

protected

Log event FileSizeError

Failed to get file size

Parameters

fileName	The name of the file
status	The error status

Definition at line 3053 of file FileManagerComponentAc.cpp.

log_WARNING_HI_ShellCommandFailed()

void Svc::FileManagerComponentBase::log_WARNING_HI_ShellCommandFailed ( const Fw::LogStringArg & command, U32 status )

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 1775 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 946 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 1317 of file FileManagerComponentAc.cpp.

pingIn_handler()

virtual void Svc::FileManagerComponentBase::pingIn_handler ( NATIVE_INT_TYPE 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 ( NATIVE_INT_TYPE 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 777 of file FileManagerComponentAc.cpp.

pingIn_preMsgHook()

void Svc::FileManagerComponentBase::pingIn_preMsgHook ( NATIVE_INT_TYPE 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 838 of file FileManagerComponentAc.cpp.

pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 851 of file FileManagerComponentAc.cpp.

regCommands()

void Svc::FileManagerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 557 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 1005 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 1326 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 non-existent 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 1064 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 1335 of file FileManagerComponentAc.cpp.

set_cmdRegOut_OutputPort()

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

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 347 of file FileManagerComponentAc.cpp.

set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 361 of file FileManagerComponentAc.cpp.

set_eventOut_OutputPort()

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

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 375 of file FileManagerComponentAc.cpp.

set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 421 of file FileManagerComponentAc.cpp.

set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 389 of file FileManagerComponentAc.cpp.

set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 403 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 1123 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 1344 of file FileManagerComponentAc.cpp.

tlmWrite_CommandsExecuted()

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

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 3233 of file FileManagerComponentAc.cpp.

tlmWrite_Errors()

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

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 3266 of file FileManagerComponentAc.cpp.

Friends And Related Symbol Documentation

FileManagerComponentBaseFriend

friend class FileManagerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 43 of file FileManagerComponentAc.hpp.

---

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

• docs-cache/F-Prime/Svc/FileManager/FileManagerComponentAc.hpp
• docs-cache/F-Prime/Svc/FileManager/FileManagerComponentAc.cpp