Svc::FileDownlinkComponentBase Class Reference

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

#include <Svc/FileDownlink/FileDownlinkComponentAc.hpp>

Inheritance diagram for Svc::FileDownlinkComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize FileDownlinkComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputSchedPort *	get_Run_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputSendFileRequestPort *	get_SendFile_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputBufferSendPort *	get_bufferReturn_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]. More...
void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...
void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...
void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...
void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum]. More...
void	set_FileComplete_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputSendFileCompletePort *port)
	Connect port to FileComplete[portNum]. More...
void	set_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOut[portNum]. More...
void	set_pingOut_OutputPort (NATIVE_INT_TYPE 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 (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 More...
	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 More...
void	exit ()
	exit task in active component More...
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{ NUM_RUN_INPUT_PORTS = 1 , NUM_SENDFILE_INPUT_PORTS = 1 , NUM_BUFFERRETURN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1 ,   NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_FILECOMPLETE_OUTPUT_PORTS = 1 , NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{ OPCODE_SENDFILE = 0x0 , OPCODE_CANCEL = 0x1 , OPCODE_SENDPARTIAL = 0x2 }
	Command opcodes. More...
enum	{   EVENTID_FILEOPENERROR = 0x0 , EVENTID_FILEREADERROR = 0x1 , EVENTID_FILESENT = 0x2 , EVENTID_DOWNLINKCANCELED = 0x3 ,   EVENTID_DOWNLINKTIMEOUT = 0x4 , EVENTID_DOWNLINKPARTIALWARNING = 0x5 , EVENTID_DOWNLINKPARTIALFAIL = 0x6 , EVENTID_SENDDATAFAIL = 0x7 ,   EVENTID_SENDSTARTED = 0x8 }
	Event IDs. More...
enum	{ CHANNELID_FILESSENT = 0x0 , CHANNELID_PACKETSSENT = 0x1 , CHANNELID_WARNINGS = 0x2 }
	Channel IDs. More...

Protected Member Functions
	FileDownlinkComponentBase (const char *compName="")
	Construct FileDownlinkComponentBase object. More...
virtual	~FileDownlinkComponentBase ()
	Destroy FileDownlinkComponentBase object. More...
NATIVE_INT_TYPE	getNum_cmdIn_InputPorts () const
NATIVE_INT_TYPE	getNum_Run_InputPorts () const
NATIVE_INT_TYPE	getNum_SendFile_InputPorts () const
NATIVE_INT_TYPE	getNum_bufferReturn_InputPorts () const
NATIVE_INT_TYPE	getNum_pingIn_InputPorts () const
NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_eventOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts () const
NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_FileComplete_OutputPorts () const
NATIVE_INT_TYPE	getNum_bufferSendOut_OutputPorts () const
NATIVE_INT_TYPE	getNum_pingOut_OutputPorts () const
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_FileComplete_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
virtual void	Run_handler (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)=0
	Handler for input port Run. More...
virtual Svc::SendFileResponse	SendFile_handler (NATIVE_INT_TYPE portNum, const Svc::SendFileRequestPortStrings::StringSize100 &sourceFileName, const Svc::SendFileRequestPortStrings::StringSize100 &destFileName, U32 offset, U32 length)=0
	Handler for input port SendFile. More...
virtual void	bufferReturn_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferReturn. More...
virtual void	pingIn_handler (NATIVE_INT_TYPE portNum, U32 key)=0
	Handler for input port pingIn. More...
void	Run_handlerBase (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Handler base-class function for input port Run. More...
Svc::SendFileResponse	SendFile_handlerBase (NATIVE_INT_TYPE portNum, const Svc::SendFileRequestPortStrings::StringSize100 &sourceFileName, const Svc::SendFileRequestPortStrings::StringSize100 &destFileName, U32 offset, U32 length)
	Handler base-class function for input port SendFile. More...
void	bufferReturn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferReturn. More...
void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn. More...
virtual void	Run_preMsgHook (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Pre-message hook for async input port Run. More...
virtual void	bufferReturn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferReturn. More...
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
void	FileComplete_out (NATIVE_INT_TYPE portNum, const Svc::SendFileResponse &resp)
	Invoke output port FileComplete. More...
void	bufferSendOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOut. More...
void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port pingOut. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
virtual void	SendFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &sourceFileName, const Fw::CmdStringArg &destFileName)=0
virtual void	Cancel_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	SendPartial_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &sourceFileName, const Fw::CmdStringArg &destFileName, U32 startOffset, U32 length)=0
void	SendFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	Cancel_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	SendPartial_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void	SendFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SendFile. More...
virtual void	Cancel_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command Cancel. More...
virtual void	SendPartial_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SendPartial. More...
void	log_WARNING_HI_FileOpenError (const Fw::LogStringArg &fileName)
void	log_WARNING_HI_FileReadError (const Fw::LogStringArg &fileName, I32 status)
void	log_ACTIVITY_HI_FileSent (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_ACTIVITY_HI_DownlinkCanceled (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_WARNING_HI_DownlinkTimeout (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_WARNING_LO_DownlinkPartialWarning (U32 startOffset, U32 length, U32 filesize, const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	log_WARNING_HI_DownlinkPartialFail (const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName, U32 startOffset, U32 filesize)
void	log_WARNING_HI_SendDataFail (const Fw::LogStringArg &sourceFileName, U32 byteOffset)
void	log_ACTIVITY_HI_SendStarted (U32 fileSize, const Fw::LogStringArg &sourceFileName, const Fw::LogStringArg &destFileName)
void	tlmWrite_FilesSent (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_PacketsSent (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_Warnings (U32 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime ()
virtual void	lock ()
	Lock the guarded mutex. More...
virtual void	unLock ()
	Unlock the guarded mutex. More...
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...
virtual	~ActiveComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization code More...
virtual void	preamble ()
	A function that will be called before the event loop is entered. More...
virtual void	loop ()
	The function that will loop dispatching messages. More...
virtual void	finalizer ()
	A function that will be called after exiting the loop. More...
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...
virtual	~QueuedComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization function More...
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped More...
void	incNumMsgDropped ()
	increment the number of messages dropped More...
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...
virtual	~PassiveComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...
virtual	~ObjBase ()
	Destructor. More...
void	init ()
	Object initializer. More...

Friends
class	FileDownlinkComponentBaseFriend
	Friend class for 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 FileDownlink component.

A component for downlinking files

Definition at line 39 of file FileDownlinkComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 57 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_RUN_INPUT_PORTS
NUM_SENDFILE_INPUT_PORTS
NUM_BUFFERRETURN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 62 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 70 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_FILECOMPLETE_OUTPUT_PORTS
NUM_BUFFERSENDOUT_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 80 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_SENDFILE	Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.
OPCODE_CANCEL	Cancel the downlink in progress, if any.
OPCODE_SENDPARTIAL	Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Definition at line 87 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_FILEOPENERROR	An error occurred opening a file.
EVENTID_FILEREADERROR	An error occurred reading a file.
EVENTID_FILESENT	The File Downlink component successfully sent a file.
EVENTID_DOWNLINKCANCELED	The File Downlink component canceled downlink of a file.
EVENTID_DOWNLINKTIMEOUT	The File Downlink component has detected a timeout. Downlink has been canceled.
EVENTID_DOWNLINKPARTIALWARNING	The File Downlink component has detected a timeout. Downlink has been canceled.
EVENTID_DOWNLINKPARTIALFAIL	The File Downlink component has detected a timeout. Downlink has been canceled.
EVENTID_SENDDATAFAIL	The File Downlink component generated an error when trying to send a data packet.
EVENTID_SENDSTARTED	The File Downlink component started a file download.

Definition at line 94 of file FileDownlinkComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_FILESSENT	Channel ID for FilesSent.
CHANNELID_PACKETSSENT	Channel ID for PacketsSent.
CHANNELID_WARNINGS	Channel ID for Warnings.

Definition at line 107 of file FileDownlinkComponentAc.hpp.

Constructor & Destructor Documentation

FileDownlinkComponentBase()

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

protected

Construct FileDownlinkComponentBase object.

Parameters

compName

The component name

Definition at line 873 of file FileDownlinkComponentAc.cpp.

~FileDownlinkComponentBase()

Svc::FileDownlinkComponentBase::~FileDownlinkComponentBase ( )

protectedvirtual

Destroy FileDownlinkComponentBase object.

Definition at line 880 of file FileDownlinkComponentAc.cpp.

Member Function Documentation

bufferReturn_handler()

virtual void Svc::FileDownlinkComponentBase::bufferReturn_handler ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protectedpure virtual

Handler for input port bufferReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

bufferReturn_handlerBase()

void Svc::FileDownlinkComponentBase::bufferReturn_handlerBase ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protected

Handler base-class function for input port bufferReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1195 of file FileDownlinkComponentAc.cpp.

bufferReturn_preMsgHook()

void Svc::FileDownlinkComponentBase::bufferReturn_preMsgHook ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protectedvirtual

Pre-message hook for async input port bufferReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1318 of file FileDownlinkComponentAc.cpp.

bufferSendOut_out()

void Svc::FileDownlinkComponentBase::bufferSendOut_out ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protected

Invoke output port bufferSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1355 of file FileDownlinkComponentAc.cpp.

Cancel_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::Cancel_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command Cancel

Cancel the downlink in progress, if any

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Cancel_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::Cancel_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command Cancel

Cancel the downlink in progress, if any

Parameters

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

Definition at line 1465 of file FileDownlinkComponentAc.cpp.

Cancel_preMsgHook()

void Svc::FileDownlinkComponentBase::Cancel_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command Cancel.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1602 of file FileDownlinkComponentAc.cpp.

cmdResponse_out()

void Svc::FileDownlinkComponentBase::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 1389 of file FileDownlinkComponentAc.cpp.

FileComplete_out()

void Svc::FileDownlinkComponentBase::FileComplete_out ( NATIVE_INT_TYPE  portNum, const Svc::SendFileResponse &  resp  )

protected

Invoke output port FileComplete.

Parameters

portNum

The port number

Definition at line 1340 of file FileDownlinkComponentAc.cpp.

get_bufferReturn_InputPort()

Fw::InputBufferSendPort * Svc::FileDownlinkComponentBase::get_bufferReturn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

bufferReturn[portNum]

Parameters

portNum

The port number

Definition at line 541 of file FileDownlinkComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::FileDownlinkComponentBase::get_cmdIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 504 of file FileDownlinkComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::FileDownlinkComponentBase::get_pingIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 552 of file FileDownlinkComponentAc.cpp.

get_Run_InputPort()

Svc::InputSchedPort * Svc::FileDownlinkComponentBase::get_Run_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

Run[portNum]

Parameters

portNum

The port number

Definition at line 519 of file FileDownlinkComponentAc.cpp.

get_SendFile_InputPort()

Svc::InputSendFileRequestPort * Svc::FileDownlinkComponentBase::get_SendFile_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

SendFile[portNum]

Parameters

portNum

The port number

Definition at line 530 of file FileDownlinkComponentAc.cpp.

getNum_bufferReturn_InputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_bufferReturn_InputPorts ( ) const

protected

Get the number of bufferReturn input ports

Returns

The number of bufferReturn input ports

Definition at line 912 of file FileDownlinkComponentAc.cpp.

getNum_bufferSendOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_bufferSendOut_OutputPorts ( ) const

protected

Get the number of bufferSendOut output ports

Returns

The number of bufferSendOut output ports

Definition at line 978 of file FileDownlinkComponentAc.cpp.

getNum_cmdIn_InputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 890 of file FileDownlinkComponentAc.cpp.

getNum_cmdRegOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 928 of file FileDownlinkComponentAc.cpp.

getNum_cmdResponseOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 934 of file FileDownlinkComponentAc.cpp.

getNum_eventOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns

The number of eventOut output ports

Definition at line 940 of file FileDownlinkComponentAc.cpp.

getNum_FileComplete_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_FileComplete_OutputPorts ( ) const

protected

Get the number of FileComplete output ports

Returns

The number of FileComplete output ports

Definition at line 972 of file FileDownlinkComponentAc.cpp.

getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 918 of file FileDownlinkComponentAc.cpp.

getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 984 of file FileDownlinkComponentAc.cpp.

getNum_Run_InputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_Run_InputPorts ( ) const

protected

Get the number of Run input ports

Returns

The number of Run input ports

Definition at line 900 of file FileDownlinkComponentAc.cpp.

getNum_SendFile_InputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_SendFile_InputPorts ( ) const

protected

Get the number of SendFile input ports

Returns

The number of SendFile input ports

Definition at line 906 of file FileDownlinkComponentAc.cpp.

getNum_timeCaller_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 956 of file FileDownlinkComponentAc.cpp.

getNum_tlmOut_OutputPorts()

NATIVE_INT_TYPE Svc::FileDownlinkComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 962 of file FileDownlinkComponentAc.cpp.

getTime()

Fw::Time Svc::FileDownlinkComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 2645 of file FileDownlinkComponentAc.cpp.

init()

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

Initialize FileDownlinkComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 76 of file FileDownlinkComponentAc.cpp.

isConnected_bufferSendOut_OutputPort()

bool Svc::FileDownlinkComponentBase::isConnected_bufferSendOut_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port bufferSendOut is connected

Returns

Whether port bufferSendOut is connected

Parameters

portNum

The port number

Definition at line 1079 of file FileDownlinkComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 994 of file FileDownlinkComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 1005 of file FileDownlinkComponentAc.cpp.

isConnected_eventOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 1016 of file FileDownlinkComponentAc.cpp.

isConnected_FileComplete_OutputPort()

bool Svc::FileDownlinkComponentBase::isConnected_FileComplete_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port FileComplete is connected

Returns

Whether port FileComplete is connected

Parameters

portNum

The port number

Definition at line 1068 of file FileDownlinkComponentAc.cpp.

isConnected_pingOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 1090 of file FileDownlinkComponentAc.cpp.

isConnected_timeCaller_OutputPort()

bool Svc::FileDownlinkComponentBase::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 1042 of file FileDownlinkComponentAc.cpp.

isConnected_tlmOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 1053 of file FileDownlinkComponentAc.cpp.

lock()

void Svc::FileDownlinkComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 2665 of file FileDownlinkComponentAc.cpp.

log_ACTIVITY_HI_DownlinkCanceled()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_DownlinkCanceled ( const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName  )

protected

Log event DownlinkCanceled

The File Downlink component canceled downlink of a file

Parameters

sourceFileName	The source file name
destFileName	The destination file name

Definition at line 1892 of file FileDownlinkComponentAc.cpp.

log_ACTIVITY_HI_FileSent()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_FileSent ( const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName  )

protected

Log event FileSent

The File Downlink component successfully sent a file

Parameters

sourceFileName	The source file name
destFileName	The destination file name

Definition at line 1804 of file FileDownlinkComponentAc.cpp.

log_ACTIVITY_HI_SendStarted()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_SendStarted ( U32  fileSize, const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName  )

protected

Log event SendStarted

The File Downlink component started a file download.

Parameters

fileSize	The source file size
sourceFileName	The source filename
destFileName	The destination filename

Definition at line 2432 of file FileDownlinkComponentAc.cpp.

log_WARNING_HI_DownlinkPartialFail()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_DownlinkPartialFail ( const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName, U32  startOffset, U32  filesize  )

protected

Log event DownlinkPartialFail

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters

sourceFileName	The source filename
destFileName	The destination file name
startOffset	Starting file offset in bytes
filesize	Size of source file

Definition at line 2210 of file FileDownlinkComponentAc.cpp.

log_WARNING_HI_DownlinkTimeout()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_DownlinkTimeout ( const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName  )

protected

Log event DownlinkTimeout

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters

sourceFileName	The source filename
destFileName	The destination file name

Definition at line 1980 of file FileDownlinkComponentAc.cpp.

log_WARNING_HI_FileOpenError()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_FileOpenError ( const Fw::LogStringArg &  fileName )

protected

Log event FileOpenError

An error occurred opening a file

Parameters

fileName

The name of the file

Definition at line 1628 of file FileDownlinkComponentAc.cpp.

log_WARNING_HI_FileReadError()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_FileReadError ( const Fw::LogStringArg &  fileName, I32  status  )

protected

Log event FileReadError

An error occurred reading a file

Parameters

fileName	The name of the file
status	The file status of read

Definition at line 1706 of file FileDownlinkComponentAc.cpp.

log_WARNING_HI_SendDataFail()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_SendDataFail ( const Fw::LogStringArg &  sourceFileName, U32  byteOffset  )

protected

Log event SendDataFail

The File Downlink component generated an error when trying to send a data packet.

Parameters

sourceFileName	The source filename
byteOffset	Byte offset

Definition at line 2334 of file FileDownlinkComponentAc.cpp.

log_WARNING_LO_DownlinkPartialWarning()

void Svc::FileDownlinkComponentBase::log_WARNING_LO_DownlinkPartialWarning ( U32  startOffset, U32  length, U32  filesize, const Fw::LogStringArg &  sourceFileName, const Fw::LogStringArg &  destFileName  )

protected

Log event DownlinkPartialWarning

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters

startOffset	Starting file offset in bytes
length	Number of bytes to downlink
filesize	Size of source file
sourceFileName	The source filename
destFileName	The destination file name

Definition at line 2068 of file FileDownlinkComponentAc.cpp.

pingIn_handler()

virtual void Svc::FileDownlinkComponentBase::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::FileDownlinkComponentBase::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 1248 of file FileDownlinkComponentAc.cpp.

pingIn_preMsgHook()

void Svc::FileDownlinkComponentBase::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 1327 of file FileDownlinkComponentAc.cpp.

pingOut_out()

void Svc::FileDownlinkComponentBase::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 1370 of file FileDownlinkComponentAc.cpp.

regCommands()

void Svc::FileDownlinkComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 851 of file FileDownlinkComponentAc.cpp.

Run_handler()

virtual void Svc::FileDownlinkComponentBase::Run_handler ( NATIVE_INT_TYPE  portNum, NATIVE_UINT_TYPE  context  )

protectedpure virtual

Handler for input port Run.

Parameters

portNum	The port number
context	The call order

Run_handlerBase()

void Svc::FileDownlinkComponentBase::Run_handlerBase ( NATIVE_INT_TYPE  portNum, NATIVE_UINT_TYPE  context  )

protected

Handler base-class function for input port Run.

Parameters

portNum	The port number
context	The call order

Definition at line 1107 of file FileDownlinkComponentAc.cpp.

Run_preMsgHook()

void Svc::FileDownlinkComponentBase::Run_preMsgHook ( NATIVE_INT_TYPE  portNum, NATIVE_UINT_TYPE  context  )

protectedvirtual

Pre-message hook for async input port Run.

Parameters

portNum	The port number
context	The call order

Definition at line 1309 of file FileDownlinkComponentAc.cpp.

SendFile_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::SendFile_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdStringArg &  sourceFileName, const Fw::CmdStringArg &  destFileName  )

protectedpure virtual

Handler for command SendFile

Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
sourceFileName	The name of the on-board file to send
destFileName	The name of the destination file on the ground

SendFile_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::SendFile_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command SendFile

Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.

Parameters

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

Definition at line 1406 of file FileDownlinkComponentAc.cpp.

SendFile_handler()

virtual Svc::SendFileResponse Svc::FileDownlinkComponentBase::SendFile_handler ( NATIVE_INT_TYPE  portNum, const Svc::SendFileRequestPortStrings::StringSize100 &  sourceFileName, const Svc::SendFileRequestPortStrings::StringSize100 &  destFileName, U32  offset, U32  length  )

protectedpure virtual

Handler for input port SendFile.

Parameters

portNum	The port number
sourceFileName	Path of file to downlink
destFileName	Path to store downlinked file at
offset	Amount of data in bytes to downlink from file. 0 to read until end of file
length	Amount of data in bytes to downlink from file. 0 to read until end of file

SendFile_handlerBase()

Svc::SendFileResponse Svc::FileDownlinkComponentBase::SendFile_handlerBase ( NATIVE_INT_TYPE  portNum, const Svc::SendFileRequestPortStrings::StringSize100 &  sourceFileName, const Svc::SendFileRequestPortStrings::StringSize100 &  destFileName, U32  offset, U32  length  )

protected

Handler base-class function for input port SendFile.

Parameters

portNum	The port number
sourceFileName	Path of file to downlink
destFileName	Path to store downlinked file at
offset	Amount of data in bytes to downlink from file. 0 to read until end of file
length	Amount of data in bytes to downlink from file. 0 to read until end of file

Definition at line 1160 of file FileDownlinkComponentAc.cpp.

SendFile_preMsgHook()

void Svc::FileDownlinkComponentBase::SendFile_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command SendFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1591 of file FileDownlinkComponentAc.cpp.

SendPartial_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::SendPartial_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdStringArg &  sourceFileName, const Fw::CmdStringArg &  destFileName, U32  startOffset, U32  length  )

protectedpure virtual

Handler for command SendPartial

Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
sourceFileName	The name of the on-board file to send
destFileName	The name of the destination file on the ground
startOffset	Starting offset of the source file
length	Number of bytes to send from starting offset. Length of 0 implies until the end of the file

SendPartial_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::SendPartial_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command SendPartial

Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Parameters

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

Definition at line 1524 of file FileDownlinkComponentAc.cpp.

SendPartial_preMsgHook()

void Svc::FileDownlinkComponentBase::SendPartial_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command SendPartial.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1613 of file FileDownlinkComponentAc.cpp.

set_bufferSendOut_OutputPort()

void Svc::FileDownlinkComponentBase::set_bufferSendOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 673 of file FileDownlinkComponentAc.cpp.

set_cmdRegOut_OutputPort()

void Svc::FileDownlinkComponentBase::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 567 of file FileDownlinkComponentAc.cpp.

set_cmdResponseOut_OutputPort()

void Svc::FileDownlinkComponentBase::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 581 of file FileDownlinkComponentAc.cpp.

set_eventOut_OutputPort()

void Svc::FileDownlinkComponentBase::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 595 of file FileDownlinkComponentAc.cpp.

set_FileComplete_OutputPort()

void Svc::FileDownlinkComponentBase::set_FileComplete_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Svc::InputSendFileCompletePort *	port
	)

Connect port to FileComplete[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 659 of file FileDownlinkComponentAc.cpp.

set_pingOut_OutputPort()

void Svc::FileDownlinkComponentBase::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 687 of file FileDownlinkComponentAc.cpp.

set_timeCaller_OutputPort()

void Svc::FileDownlinkComponentBase::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 627 of file FileDownlinkComponentAc.cpp.

set_tlmOut_OutputPort()

void Svc::FileDownlinkComponentBase::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 641 of file FileDownlinkComponentAc.cpp.

tlmWrite_FilesSent()

void Svc::FileDownlinkComponentBase::tlmWrite_FilesSent ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel FilesSent

The total number of files sent

Parameters

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

Definition at line 2542 of file FileDownlinkComponentAc.cpp.

tlmWrite_PacketsSent()

void Svc::FileDownlinkComponentBase::tlmWrite_PacketsSent ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel PacketsSent

The total number of packets sent

Parameters

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

Definition at line 2575 of file FileDownlinkComponentAc.cpp.

tlmWrite_Warnings()

void Svc::FileDownlinkComponentBase::tlmWrite_Warnings ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel Warnings

The total number of warnings

Parameters

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

Definition at line 2608 of file FileDownlinkComponentAc.cpp.

unLock()

void Svc::FileDownlinkComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 2671 of file FileDownlinkComponentAc.cpp.

Friends And Related Function Documentation

FileDownlinkComponentBaseFriend

friend class FileDownlinkComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 48 of file FileDownlinkComponentAc.hpp.

---

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

• Svc/FileDownlink/FileDownlinkComponentAc.hpp
• Svc/FileDownlink/FileDownlinkComponentAc.cpp