#include <Svc/FileDownlink/FileDownlink.hpp>

Inheritance diagram for Svc::FileDownlink:

Public Member Functions
	Mode (void)
	Constructor. More...

void	set (const Type value)
	Set the Mode value. More...

Type	get (void)
	Get the Mode value. More...

	FileDownlink (const char *const compName, const U16 downlinkPacketSize)

void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)

	~FileDownlink (void)

void	FileDownlink_Cancel_cmdHandler (const FwOpcodeType opCode, const U32 cmdSeq)

void	pingIn_handler (const NATIVE_INT_TYPE portNum, U32 key)

Os::File::Status	sendDataPackets (void)

void	sendCancelPacket (void)

void	sendEndPacket (void)

void	sendStartPacket (void)

void	sendFilePacket (const Fw::FilePacket &filePacket)

Public Member Functions inherited from Svc::FileDownlinkComponentBase
Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_bufferGetCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferGetPort *port)

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

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

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

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

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

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

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

void	regCommands (void)
	Register commands with the Command Dispatcher. More...

void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)

virtual	~FileDownlinkComponentBase (void)

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

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)

NATIVE_INT_TYPE	getNum_pingIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts (void)

NATIVE_INT_TYPE	getNum_bufferSendOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_eventOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts (void)

bool	isConnected_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

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

void	log_WARNING_HI_FileDownlink_FileReadError (Fw::LogStringArg &fileName)

void	log_ACTIVITY_HI_FileDownlink_FileSent (Fw::LogStringArg &sourceFileName, Fw::LogStringArg &destFileName)

void	log_ACTIVITY_HI_FileDownlink_DownlinkCanceled (Fw::LogStringArg &sourceFileName, Fw::LogStringArg &destFileName)

void	tlmWrite_FileDownlink_PacketsSent (U32 arg)

void	tlmWrite_FileDownlink_Warnings (U32 arg)

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1)
	called by instantiator when task is to be started More...

void	exit (void)
	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...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization code More...

virtual void	preamble (void)
	A function that will be called before the event loop is entered. More...

virtual void	loop (void)
	The function that will loop dispatching messages. More...

virtual void	finalizer (void)
	A function that will be called after exiting the loop. More...

Public Member Functions inherited from Fw::QueuedComponentBase
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)

virtual MsgDispatchStatus	doDispatch (void)=0
	method to dispatch a single message in the queue. More...

NATIVE_INT_TYPE	getNumMsgsDropped (void)
	return number of messages dropped More...

void	incNumMsgDropped (void)
	increment the number of messages dropped More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase (void) const

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	getInstance (void) const

Public Attributes
PRIVATE	__pad1__: void FileDownlink_SendFile_cmdHandler( const FwOpcodeType opCode
	The opcode. More...

PRIVATE const U32	cmdSeq
	The command sequence number. More...

PRIVATE const U32 const Fw::CmdStringArg &	sourceFileName
	The name of the on-board file to send. More...

PRIVATE const U32 const Fw::CmdStringArg const Fw::CmdStringArg &	destFileName
	< The name of the destination file on the ground More...

PRIVATE	__pad2__: Os::File::Status sendDataPacket(const U32 byteOffset)

PRIVATE	__pad3__: const U32 downlinkPacketSize

Mode	mode
	The mode. More...

File	file
	The file. More...

FilesSent	filesSent
	Files sent. More...

PacketsSent	packetsSent
	Packets sent. More...

Warnings	warnings
	Warnings. More...

U32	sequenceIndex
	The current sequence index. More...

Public Attributes inherited from Svc::FileDownlinkComponentBase
PROTECTED	__pad0__: FileDownlinkComponentBase(void)

PROTECTED	__pad1__: virtual void pingIn_handler( NATIVE_INT_TYPE portNum

PROTECTED U32	key = 0

PROTECTED	__pad2__: void pingIn_handlerBase( NATIVE_INT_TYPE portNum

PROTECTED	__pad3__: virtual void pingIn_preMsgHook( NATIVE_INT_TYPE portNum

PROTECTED	__pad4__: Fw::Buffer bufferGetCaller_out( NATIVE_INT_TYPE portNum

PROTECTED U32	size

PROTECTED	__pad5__: NATIVE_INT_TYPE getNum_cmdIn_InputPorts(void)

PROTECTED	__pad6__: NATIVE_INT_TYPE getNum_bufferGetCaller_OutputPorts(void)

PROTECTED	__pad7__: bool isConnected_bufferGetCaller_OutputPort( NATIVE_INT_TYPE portNum )

PROTECTED	__pad8__: enum { OPCODE_FILEDOWNLINK_SENDFILE = 0

PROTECTED	OPCODE_FILEDOWNLINK_CANCEL = 1

PROTECTED	PROTECTED: virtual void FileDownlink_SendFile_cmdHandler( FwOpcodeType opCode

PROTECTED U32	cmdSeq

PROTECTED U32 const Fw::CmdStringArg &	sourceFileName

PROTECTED U32 const Fw::CmdStringArg const Fw::CmdStringArg &	destFileName = 0

PROTECTED	__pad9__: virtual void FileDownlink_SendFile_preMsgHook( FwOpcodeType opCode

PROTECTED	__pad10__: void FileDownlink_SendFile_cmdHandlerBase( FwOpcodeType opCode

PROTECTED U32 Fw::CmdArgBuffer &	args

PROTECTED	__pad11__: void cmdResponse_out( FwOpcodeType opCode

PROTECTED U32 Fw::CommandResponse	response

PROTECTED	__pad12__: enum { EVENTID_FILEDOWNLINK_FILEOPENERROR = 0

PROTECTED	EVENTID_FILEDOWNLINK_FILEREADERROR = 1

PROTECTED	EVENTID_FILEDOWNLINK_FILESENT = 2

PROTECTED	EVENTID_FILEDOWNLINK_DOWNLINKCANCELED = 3

PROTECTED	__pad13__: enum { CHANNELID_FILEDOWNLINK_FILESSENT = 0
	Channel ID for FileDownlink_FilesSent. More...

PROTECTED	CHANNELID_FILEDOWNLINK_PACKETSSENT = 1
	Channel ID for FileDownlink_PacketsSent. More...

PROTECTED	CHANNELID_FILEDOWNLINK_WARNINGS = 2
	Channel ID for FileDownlink_Warnings. More...

PROTECTED	__pad14__: Fw::Time getTime(void)

PRIVATE	__pad15__: Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS]

Svc::InputPingPort	m_pingIn_InputPort [NUM_PINGIN_INPUT_PORTS]

PRIVATE	__pad16__: Fw::OutputBufferGetPort m_bufferGetCaller_OutputPort[NUM_BUFFERGETCALLER_OUTPUT_PORTS]

Fw::OutputTimePort	m_timeCaller_OutputPort [NUM_TIMECALLER_OUTPUT_PORTS]

Fw::OutputBufferSendPort	m_bufferSendOut_OutputPort [NUM_BUFFERSENDOUT_OUTPUT_PORTS]

Fw::OutputTlmPort	m_tlmOut_OutputPort [NUM_TLMOUT_OUTPUT_PORTS]

Fw::OutputCmdResponsePort	m_cmdResponseOut_OutputPort [NUM_CMDRESPONSEOUT_OUTPUT_PORTS]

Fw::OutputCmdRegPort	m_cmdRegOut_OutputPort [NUM_CMDREGOUT_OUTPUT_PORTS]

Fw::OutputLogPort	m_eventOut_OutputPort [NUM_EVENTOUT_OUTPUT_PORTS]

Svc::OutputPingPort	m_pingOut_OutputPort [NUM_PINGOUT_OUTPUT_PORTS]

PRIVATE	__pad17__: static void m_p_cmdIn_in( Fw::PassiveComponentBase* callComp

PRIVATE NATIVE_INT_TYPE	portNum

PRIVATE NATIVE_INT_TYPE FwOpcodeType	opCode

PRIVATE NATIVE_INT_TYPE FwOpcodeType U32	cmdSeq

PRIVATE NATIVE_INT_TYPE FwOpcodeType U32 Fw::CmdArgBuffer &	args

PRIVATE	__pad18__: virtual MsgDispatchStatus doDispatch(void)

Public Attributes inherited from Fw::ActiveComponentBase
PROTECTED	__pad0__: ActiveComponentBase(const char* name)
	Constructor. More...

Os::Task	m_task
	task object for active component More...

PRIVATE	__pad1__: static void s_baseTask(void*)
	function provided to task class for new thread. More...

Public Attributes inherited from Fw::QueuedComponentBase
PROTECTED	__pad0__: QueuedComponentBase(const char* name)
	Constructor. More...

Os::Queue	m_queue
	queue object for active component More...

PRIVATE	__pad1__: NATIVE_INT_TYPE m_msgsDropped
	number of messages dropped from full queue More...

Public Attributes inherited from Fw::PassiveComponentBase
PROTECTED	__pad0__: PassiveComponentBase(const char* name)
	Named constructor. More...

PRIVATE	__pad1__: U32 m_idBase
	ID base for opcodes etc. More...

NATIVE_INT_TYPE	m_instance
	instance of component object More...

Additional Inherited Members
Public Types inherited from Svc::FileDownlinkComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 }

enum	{ NUM_BUFFERGETCALLER_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1, NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1 }

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 }

Static Public Member Functions inherited from Svc::FileDownlinkComponentBase
static void	m_p_pingIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, U32 key)

Static Public Member Functions inherited from Fw::ActiveComponentBase
static void	s_baseBareTask (void *)
	function provided to task class for new thread. More...

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init (void)
	Object initializer. More...

Detailed Description

Definition at line 23 of file FileDownlink.hpp.

Constructor & Destructor Documentation

◆ FileDownlink()

Svc::FileDownlink::FileDownlink	(	const char *const	compName,
		const U16	downlinkPacketSize
	)

Construct object FileDownlink

Parameters

compName	The component name
downlinkPacketSize	The size of a downlink packet

Definition at line 23 of file FileDownlink.cpp.

◆ ~FileDownlink()

Svc::FileDownlink::~FileDownlink ( void )

Destroy object FileDownlink

Definition at line 47 of file FileDownlink.cpp.

Member Function Documentation

◆ FileDownlink_Cancel_cmdHandler()

void Svc::FileDownlink::FileDownlink_Cancel_cmdHandler	(	const FwOpcodeType	opCode,
		const U32	cmdSeq
	)

virtual

Implementation for FileDownlink_Cancel command handler

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Implements Svc::FileDownlinkComponentBase.

Definition at line 124 of file FileDownlink.cpp.

◆ get()

Type Svc::FileDownlink::get ( void )

inline

Get the Mode value.

Definition at line 56 of file FileDownlink.hpp.

◆ init()

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

Initialize object FileDownlink

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 38 of file FileDownlink.cpp.

◆ Mode()

Svc::FileDownlink::Mode ( void )

inline

Constructor.

Definition at line 44 of file FileDownlink.hpp.

◆ pingIn_handler()

void Svc::FileDownlink::pingIn_handler	(	const NATIVE_INT_TYPE	portNum,
		U32	key
	)

Handler implementation for pingIn

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 250 of file FileDownlink.cpp.

◆ sendCancelPacket()

void Svc::FileDownlink::sendCancelPacket ( void )

Definition at line 191 of file FileDownlink.cpp.

◆ sendDataPackets()

Os::File::Status Svc::FileDownlink::sendDataPackets ( void )

Definition at line 172 of file FileDownlink.cpp.

◆ sendEndPacket()

void Svc::FileDownlink::sendEndPacket ( void )

Definition at line 202 of file FileDownlink.cpp.

◆ sendFilePacket()

void Svc::FileDownlink::sendFilePacket ( const Fw::FilePacket & filePacket )

Definition at line 237 of file FileDownlink.cpp.

◆ sendStartPacket()

void Svc::FileDownlink::sendStartPacket ( void )

Definition at line 223 of file FileDownlink.cpp.

◆ set()

void Svc::FileDownlink::set ( const Type value )

inline

Set the Mode value.

Definition at line 49 of file FileDownlink.hpp.

Member Data Documentation

◆ pad1

PRIVATE Svc::FileDownlink::__pad1__

The opcode.

Definition at line 238 of file FileDownlink.hpp.

◆ pad2

PRIVATE Svc::FileDownlink::__pad2__

Definition at line 268 of file FileDownlink.hpp.

◆ pad3

PRIVATE Svc::FileDownlink::__pad3__

Definition at line 286 of file FileDownlink.hpp.

◆ cmdSeq

PRIVATE const U32 Svc::FileDownlink::cmdSeq

The command sequence number.

Definition at line 248 of file FileDownlink.hpp.

◆ destFileName

PRIVATE const U32 const Fw::CmdStringArg const Fw::CmdStringArg& Svc::FileDownlink::destFileName

< The name of the destination file on the ground

Definition at line 250 of file FileDownlink.hpp.

◆ file

File Svc::FileDownlink::file

The file.

Definition at line 299 of file FileDownlink.hpp.

◆ filesSent

FilesSent Svc::FileDownlink::filesSent

Files sent.

Definition at line 302 of file FileDownlink.hpp.

◆ mode

Mode Svc::FileDownlink::mode

The mode.

Definition at line 296 of file FileDownlink.hpp.

◆ packetsSent

PacketsSent Svc::FileDownlink::packetsSent

Packets sent.

Definition at line 305 of file FileDownlink.hpp.

◆ sequenceIndex

U32 Svc::FileDownlink::sequenceIndex

The current sequence index.

Definition at line 311 of file FileDownlink.hpp.

◆ sourceFileName

PRIVATE const U32 const Fw::CmdStringArg& Svc::FileDownlink::sourceFileName

The name of the on-board file to send.

Definition at line 249 of file FileDownlink.hpp.

◆ warnings

Warnings Svc::FileDownlink::warnings

Warnings.

Definition at line 308 of file FileDownlink.hpp.

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

Svc/FileDownlink/FileDownlink.hpp
Svc/FileDownlink/FileDownlink.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileDownlink()

◆ ~FileDownlink()

Member Function Documentation

◆ FileDownlink_Cancel_cmdHandler()

◆ get()

◆ init()

◆ Mode()

◆ pingIn_handler()

◆ sendCancelPacket()

◆ sendDataPackets()

◆ sendEndPacket()

◆ sendFilePacket()

◆ sendStartPacket()

◆ set()

Member Data Documentation

◆ __pad1__

◆ __pad2__

◆ __pad3__

◆ cmdSeq

◆ destFileName

◆ file

◆ filesSent

◆ mode

◆ packetsSent

◆ sequenceIndex

◆ sourceFileName

◆ warnings

◆ pad1

◆ pad2

◆ pad3