#include <Svc/FileManager/FileManager.hpp>

Inheritance diagram for Svc::FileManager:

Public Member Functions
	FileManager (const char *const compName)

void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)

	~FileManager ()

Public Member Functions inherited from Svc::FileManagerComponentBase
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

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }

Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }

Protected Types inherited from Svc::FileManagerComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_CREATEDIRECTORY = 0x0 , OPCODE_MOVEFILE = 0x1 , OPCODE_REMOVEDIRECTORY = 0x2 , OPCODE_REMOVEFILE = 0x3 , OPCODE_SHELLCOMMAND = 0x4 , OPCODE_APPENDFILE = 0x5 , OPCODE_FILESIZE = 0x6 }
	Command opcodes. More...

enum	{ EVENTID_DIRECTORYCREATEERROR = 0x0 , EVENTID_DIRECTORYREMOVEERROR = 0x1 , EVENTID_FILEMOVEERROR = 0x2 , EVENTID_FILEREMOVEERROR = 0x3 , EVENTID_SHELLCOMMANDFAILED = 0x4 , EVENTID_APPENDFILEFAILED = 0x5 , EVENTID_APPENDFILESUCCEEDED = 0x6 , EVENTID_SHELLCOMMANDSUCCEEDED = 0x7 , EVENTID_CREATEDIRECTORYSUCCEEDED = 0x8 , EVENTID_REMOVEDIRECTORYSUCCEEDED = 0x9 , EVENTID_MOVEFILESUCCEEDED = 0xa , EVENTID_REMOVEFILESUCCEEDED = 0xb , EVENTID_APPENDFILESTARTED = 0xc , EVENTID_SHELLCOMMANDSTARTED = 0xd , EVENTID_CREATEDIRECTORYSTARTED = 0xe , EVENTID_REMOVEDIRECTORYSTARTED = 0xf , EVENTID_MOVEFILESTARTED = 0x10 , EVENTID_REMOVEFILESTARTED = 0x11 , EVENTID_FILESIZESUCCEEDED = 0x12 , EVENTID_FILESIZEERROR = 0x13 , EVENTID_FILESIZESTARTED = 0x14 }
	Event IDs. More...

enum	{ CHANNELID_COMMANDSEXECUTED = 0x0 , CHANNELID_ERRORS = 0x1 }
	Channel IDs. More...

Protected Member Functions inherited from Svc::FileManagerComponentBase
	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)

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.

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.

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

Definition at line 21 of file FileManager.hpp.

Constructor & Destructor Documentation

◆ FileManager()

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

Construct object FileManager

Parameters

compName The component name

Definition at line 26 of file FileManager.cpp.

◆ ~FileManager()

Svc::FileManager::~FileManager ( )

Destroy object FileManager

Definition at line 46 of file FileManager.cpp.

Member Function Documentation

◆ init()

void Svc::FileManager::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance )

Initialize object FileManager

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 37 of file FileManager.cpp.

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

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