#include <Svc/FileUplink/FileUplink.hpp>

Inheritance diagram for Svc::FileUplink:

Public Member Functions
	FileUplink (const char *const name)

void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)

	~FileUplink (void)

void	pingIn_handler (const NATIVE_INT_TYPE portNum, U32 key)

void	handleDataPacket (const Fw::FilePacket::DataPacket &dataPacket)
	Handle a data packet. More...

void	handleEndPacket (const Fw::FilePacket::EndPacket &endPacket)
	Handle an end packet. More...

void	handleCancelPacket (void)
	Handle a cancel packet. More...

void	checkSequenceIndex (const U32 sequenceIndex)
	Check sequence index. More...

void	compareChecksums (const Fw::FilePacket::EndPacket &endPacket)
	Compare checksums. More...

void	goToStartMode (void)
	Go to START mode. More...

void	goToDataMode (void)
	Go to DATA mode. More...

Public Member Functions inherited from Svc::FileUplinkComponentBase
Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

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_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)

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

void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)

virtual	~FileUplinkComponentBase (void)

void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)

virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)

NATIVE_INT_TYPE	getNum_pingIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_bufferSendOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_eventOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts (void)

bool	isConnected_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

void	log_WARNING_HI_FileUplink_FileOpenError (Fw::LogStringArg &fileName)

void	log_ACTIVITY_HI_FileUplink_FileReceived (Fw::LogStringArg &fileName)

void	log_WARNING_HI_FileUplink_FileWriteError (Fw::LogStringArg &fileName)

void	log_WARNING_HI_FileUplink_FileWriteError_ThrottleClear (void)

void	log_WARNING_HI_FileUplink_InvalidReceiveMode (U32 packetType, U32 mode)

void	log_WARNING_HI_FileUplink_InvalidReceiveMode_ThrottleClear (void)

void	log_WARNING_HI_FileUplink_PacketOutOfBounds (U32 packetIndex, Fw::LogStringArg &fileName)

void	log_WARNING_HI_FileUplink_PacketOutOfBounds_ThrottleClear (void)

void	log_WARNING_HI_FileUplink_PacketOutOfOrder (U32 packetIndex, U32 lastPacketIndex)

void	log_WARNING_HI_FileUplink_PacketOutOfOrder_ThrottleClear (void)

void	log_ACTIVITY_HI_FileUplink_UplinkCanceled (void)

void	tlmWrite_FileUplink_PacketsReceived (U32 arg)

void	tlmWrite_FileUplink_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 bufferSendIn_handler( const NATIVE_INT_TYPE portNum
	The port number. More...

PRIVATE Fw::Buffer &	buffer

PRIVATE	__pad2__: void handleStartPacket(const Fw::FilePacket::StartPacket& startPacket)

PRIVATE	__pad3__: ReceiveMode receiveMode

U32	lastSequenceIndex
	The sequence index of the last packet received. More...

File	file
	The file being assembled. More...

FilesReceived	filesReceived
	The total number of files received. More...

PacketsReceived	packetsReceived
	The total number of cancel packets. More...

Warnings	warnings
	The total number of warnings. More...

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

PROTECTED	__pad1__: virtual void bufferSendIn_handler( NATIVE_INT_TYPE portNum

PROTECTED Fw::Buffer &	fwBuffer = 0

PROTECTED	__pad2__: void bufferSendIn_handlerBase( NATIVE_INT_TYPE portNum

PROTECTED	__pad3__: virtual void bufferSendIn_preMsgHook( NATIVE_INT_TYPE portNum

PROTECTED	__pad4__: void bufferSendOut_out( NATIVE_INT_TYPE portNum

PROTECTED	__pad5__: NATIVE_INT_TYPE getNum_bufferSendIn_InputPorts(void)

PROTECTED	__pad6__: NATIVE_INT_TYPE getNum_timeCaller_OutputPorts(void)

PROTECTED	__pad7__: bool isConnected_timeCaller_OutputPort( NATIVE_INT_TYPE portNum )

PROTECTED	__pad8__: enum { EVENTID_FILEUPLINK_BADCHECKSUM = 0

PROTECTED	EVENTID_FILEUPLINK_FILEOPENERROR = 1

PROTECTED	EVENTID_FILEUPLINK_FILERECEIVED = 2

PROTECTED	EVENTID_FILEUPLINK_FILEWRITEERROR = 3

PROTECTED	EVENTID_FILEUPLINK_INVALIDRECEIVEMODE = 4

PROTECTED	EVENTID_FILEUPLINK_PACKETOUTOFBOUNDS = 5

PROTECTED	EVENTID_FILEUPLINK_PACKETOUTOFORDER = 6

PROTECTED	EVENTID_FILEUPLINK_UPLINKCANCELED = 7

PROTECTED	__pad9__: void log_WARNING_HI_FileUplink_BadChecksum( Fw::LogStringArg& fileName

PROTECTED U32	computed

PROTECTED U32 U32	read

PROTECTED	__pad10__: enum { CHANNELID_FILEUPLINK_FILESRECEIVED = 0
	Channel ID for FileUplink_FilesReceived. More...

PROTECTED	CHANNELID_FILEUPLINK_PACKETSRECEIVED = 1
	Channel ID for FileUplink_PacketsReceived. More...

PROTECTED	CHANNELID_FILEUPLINK_WARNINGS = 2
	Channel ID for FileUplink_Warnings. More...

PROTECTED	PROTECTED: void tlmWrite_FileUplink_FilesReceived( U32 arg )

PROTECTED	__pad11__: Fw::Time getTime(void)

PRIVATE	__pad12__: Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS]

Svc::InputPingPort	m_pingIn_InputPort [NUM_PINGIN_INPUT_PORTS]

PRIVATE	__pad13__: 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::OutputLogPort	m_eventOut_OutputPort [NUM_EVENTOUT_OUTPUT_PORTS]

Svc::OutputPingPort	m_pingOut_OutputPort [NUM_PINGOUT_OUTPUT_PORTS]

PRIVATE	__pad14__: static void m_p_bufferSendIn_in( Fw::PassiveComponentBase* callComp

PRIVATE NATIVE_INT_TYPE	portNum

PRIVATE NATIVE_INT_TYPE Fw::Buffer &	fwBuffer

PRIVATE	__pad15__: virtual MsgDispatchStatus doDispatch(void)

PRIVATE	__pad16__: NATIVE_UINT_TYPE m_FileUplink_FileWriteErrorThrottle
	throttle for FileUplink_FileWriteError More...

NATIVE_UINT_TYPE	m_FileUplink_InvalidReceiveModeThrottle
	throttle for FileUplink_InvalidReceiveMode More...

NATIVE_UINT_TYPE	m_FileUplink_PacketOutOfBoundsThrottle
	throttle for FileUplink_PacketOutOfBounds More...

NATIVE_UINT_TYPE	m_FileUplink_PacketOutOfOrderThrottle
	throttle for FileUplink_PacketOutOfOrder More...

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::FileUplinkComponentBase
enum	{ NUM_BUFFERSENDIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 }

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

enum	{ EVENTID_FILEUPLINK_FILEWRITEERROR_THROTTLE = 5, EVENTID_FILEUPLINK_INVALIDRECEIVEMODE_THROTTLE = 5, EVENTID_FILEUPLINK_PACKETOUTOFBOUNDS_THROTTLE = 5, EVENTID_FILEUPLINK_PACKETOUTOFORDER_THROTTLE = 20 }

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::FileUplinkComponentBase
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 22 of file FileUplink.hpp.

Constructor & Destructor Documentation

◆ FileUplink()

Svc::FileUplink::FileUplink ( const char *const name )

Construct object FileUplink

Parameters

name	The component name

Definition at line 23 of file FileUplink.cpp.

◆ ~FileUplink()

Svc::FileUplink::~FileUplink ( void )

Destroy object FileUplink

Definition at line 44 of file FileUplink.cpp.

Member Function Documentation

◆ checkSequenceIndex()

void Svc::FileUplink::checkSequenceIndex ( const U32 sequenceIndex )

Check sequence index.

Definition at line 171 of file FileUplink.cpp.

◆ compareChecksums()

void Svc::FileUplink::compareChecksums ( const Fw::FilePacket::EndPacket & endPacket )

Compare checksums.

Definition at line 183 of file FileUplink.cpp.

◆ goToDataMode()

void Svc::FileUplink::goToDataMode ( void )

Go to DATA mode.

Definition at line 205 of file FileUplink.cpp.

◆ goToStartMode()

void Svc::FileUplink::goToStartMode ( void )

Go to START mode.

Definition at line 197 of file FileUplink.cpp.

◆ handleCancelPacket()

void Svc::FileUplink::handleCancelPacket ( void )

Handle a cancel packet.

Definition at line 163 of file FileUplink.cpp.

◆ handleDataPacket()

void Svc::FileUplink::handleDataPacket ( const Fw::FilePacket::DataPacket & dataPacket )

Handle a data packet.

Definition at line 121 of file FileUplink.cpp.

◆ handleEndPacket()

void Svc::FileUplink::handleEndPacket ( const Fw::FilePacket::EndPacket & endPacket )

Handle an end packet.

Definition at line 147 of file FileUplink.cpp.

◆ init()

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

Initialize object FileUplink

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 35 of file FileUplink.cpp.

◆ pingIn_handler()

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

virtual

Handler implementation for pingIn

Parameters

portNum	The port number
key	Value to return to pinger

Implements Svc::FileUplinkComponentBase.

Definition at line 84 of file FileUplink.cpp.

Member Data Documentation

◆ pad1

PRIVATE Svc::FileUplink::__pad1__

The port number.

Definition at line 211 of file FileUplink.hpp.

◆ pad2

PRIVATE Svc::FileUplink::__pad2__

Definition at line 232 of file FileUplink.hpp.

◆ pad3

PRIVATE Svc::FileUplink::__pad3__

Definition at line 262 of file FileUplink.hpp.

◆ buffer

PRIVATE Fw::Buffer& Svc::FileUplink::buffer

Definition at line 221 of file FileUplink.hpp.

◆ file

File Svc::FileUplink::file

The file being assembled.

Definition at line 275 of file FileUplink.hpp.

◆ filesReceived

FilesReceived Svc::FileUplink::filesReceived

The total number of files received.

Definition at line 278 of file FileUplink.hpp.

◆ lastSequenceIndex

U32 Svc::FileUplink::lastSequenceIndex

The sequence index of the last packet received.

Definition at line 272 of file FileUplink.hpp.

◆ packetsReceived

PacketsReceived Svc::FileUplink::packetsReceived

The total number of cancel packets.

Definition at line 281 of file FileUplink.hpp.

◆ warnings

Warnings Svc::FileUplink::warnings

The total number of warnings.

Definition at line 284 of file FileUplink.hpp.

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

Svc/FileUplink/FileUplink.hpp
Svc/FileUplink/FileUplink.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileUplink()

◆ ~FileUplink()

Member Function Documentation

◆ checkSequenceIndex()

◆ compareChecksums()

◆ goToDataMode()

◆ goToStartMode()

◆ handleCancelPacket()

◆ handleDataPacket()

◆ handleEndPacket()

◆ init()

◆ pingIn_handler()

Member Data Documentation

◆ __pad1__

◆ __pad2__

◆ __pad3__

◆ buffer

◆ file

◆ filesReceived

◆ lastSequenceIndex

◆ packetsReceived

◆ warnings

◆ pad1

◆ pad2

◆ pad3