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

#include <Svc/FileUplink/FileUplinkComponentAc.hpp>

Inheritance diagram for Svc::FileUplinkComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize FileUplinkComponentBase object. More...

Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

void	set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...

void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...

void	set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum]. More...

void	set_bufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOut[portNum]. More...

void	set_fileAnnounce_OutputPort (FwIndexType portNum, Svc::InputFileAnnouncePort *port)
	Connect port to fileAnnounce[portNum]. More...

void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

Public Member Functions inherited from Fw::QueuedComponentBase
void	deinit () override
	Allows de-initialization on teardown. More...

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

FwIdType	getIdBase () const

Protected Types
enum	{ NUM_BUFFERSENDIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGTEXT_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_BUFFERSENDOUT_OUTPUT_PORTS = 1, NUM_FILEANNOUNCE_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_BADCHECKSUM = 0x0, EVENTID_FILEOPENERROR = 0x1, EVENTID_FILERECEIVED = 0x2, EVENTID_FILEWRITEERROR = 0x3, EVENTID_INVALIDRECEIVEMODE = 0x4, EVENTID_PACKETOUTOFBOUNDS = 0x5, EVENTID_PACKETOUTOFORDER = 0x6, EVENTID_PACKETDUPLICATE = 0x7, EVENTID_UPLINKCANCELED = 0x8, EVENTID_DECODEERROR = 0x9, EVENTID_INVALIDPACKETRECEIVED = 0xa }
	Event IDs. More...

enum	{ EVENTID_FILEWRITEERROR_THROTTLE = 5, EVENTID_INVALIDRECEIVEMODE_THROTTLE = 5, EVENTID_PACKETOUTOFBOUNDS_THROTTLE = 5, EVENTID_PACKETOUTOFORDER_THROTTLE = 20, EVENTID_PACKETDUPLICATE_THROTTLE = 20 }
	Event throttle values: sets initial value of countdown variables. More...

enum	{ CHANNELID_FILESRECEIVED = 0x0, CHANNELID_PACKETSRECEIVED = 0x1, CHANNELID_WARNINGS = 0x2 }
	Channel IDs. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions
	FileUplinkComponentBase (const char *compName="")
	Construct FileUplinkComponentBase object. More...

virtual	~FileUplinkComponentBase ()
	Destroy FileUplinkComponentBase object. More...

bool	isConnected_eventOut_OutputPort (FwIndexType portNum) const

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum) const

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum) const

bool	isConnected_bufferSendOut_OutputPort (FwIndexType portNum) const

bool	isConnected_fileAnnounce_OutputPort (FwIndexType portNum) const

bool	isConnected_pingOut_OutputPort (FwIndexType portNum) const

virtual void	bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendIn. More...

virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...

void	bufferSendIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendIn. More...

void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...

virtual void	bufferSendIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendIn. More...

virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

void	bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const
	Invoke output port bufferSendOut. More...

void	fileAnnounce_out (FwIndexType portNum, Fw::StringBase &file_name) const
	Invoke output port fileAnnounce. More...

void	pingOut_out (FwIndexType portNum, U32 key) const
	Invoke output port pingOut. More...

void	log_WARNING_HI_BadChecksum (const Fw::StringBase &fileName, U32 computed, U32 read) const

void	log_WARNING_HI_FileOpenError (const Fw::StringBase &fileName) const

void	log_ACTIVITY_HI_FileReceived (const Fw::StringBase &fileName) const

void	log_WARNING_HI_FileWriteError (const Fw::StringBase &fileName)

void	log_WARNING_HI_InvalidReceiveMode (FwPacketDescriptorType packetType, U32 mode)

void	log_WARNING_HI_PacketOutOfBounds (U32 packetIndex, const Fw::StringBase &fileName)

void	log_WARNING_HI_PacketOutOfOrder (U32 packetIndex, U32 lastPacketIndex)

void	log_WARNING_HI_PacketDuplicate (U32 packetIndex)

void	log_ACTIVITY_HI_UplinkCanceled () const

void	log_WARNING_HI_DecodeError (I32 status) const

void	log_WARNING_HI_InvalidPacketReceived (FwPacketDescriptorType packetType) const

void	log_WARNING_HI_FileWriteError_ThrottleClear ()
	Reset throttle value for FileWriteError. More...

void	log_WARNING_HI_InvalidReceiveMode_ThrottleClear ()
	Reset throttle value for InvalidReceiveMode. More...

void	log_WARNING_HI_PacketOutOfBounds_ThrottleClear ()
	Reset throttle value for PacketOutOfBounds. More...

void	log_WARNING_HI_PacketOutOfOrder_ThrottleClear ()
	Reset throttle value for PacketOutOfOrder. More...

void	log_WARNING_HI_PacketDuplicate_ThrottleClear ()
	Reset throttle value for PacketDuplicate. More...

void	tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_FilesReceived (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_PacketsReceived (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

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

Fw::Time	getTime () const

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

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

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

MsgDispatchStatus	dispatch ()
	The function that will 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 (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

MsgDispatchStatus	dispatchAvailableMessages ()
	dispatches all messages currently in the queue, returning status of the dispatch More...

FwSizeType	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 (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	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...

Static Protected Member Functions
static constexpr FwIndexType	getNum_bufferSendIn_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_eventOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_tlmOut_OutputPorts ()

static constexpr FwIndexType	getNum_bufferSendOut_OutputPorts ()

static constexpr FwIndexType	getNum_fileAnnounce_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

Friends
class	FileUplinkTesterBase
	Friend class tester to support autocoded test harness. More...

class	FileUplinkTester
	Friend class tester implementation to support 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 FileUplink component.

A component for uplinking files

Definition at line 40 of file FileUplinkComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERSENDIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 60 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGTEXT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 66 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERSENDOUT_OUTPUT_PORTS
NUM_FILEANNOUNCE_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 74 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_BADCHECKSUM	During receipt of a file, the computed checksum value did not match the stored value.
EVENTID_FILEOPENERROR	An error occurred opening a file.
EVENTID_FILERECEIVED	The File Uplink component successfully received a file.
EVENTID_FILEWRITEERROR	An error occurred writing to a file.
EVENTID_INVALIDRECEIVEMODE	The File Uplink component received a packet with a type that was invalid for the current receive mode.
EVENTID_PACKETOUTOFBOUNDS	During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file.
EVENTID_PACKETOUTOFORDER	The File Uplink component encountered an out-of-order packet during file receipt.
EVENTID_PACKETDUPLICATE	The File Uplink component encountered a duplicate packet during file receipt.
EVENTID_UPLINKCANCELED	The File Uplink component received a CANCEL packet.
EVENTID_DECODEERROR	Error decoding file packet.
EVENTID_INVALIDPACKETRECEIVED	Invalid packet received.

Definition at line 81 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_FILEWRITEERROR_THROTTLE	Throttle reset count for FileWriteError.
EVENTID_INVALIDRECEIVEMODE_THROTTLE	Throttle reset count for InvalidReceiveMode.
EVENTID_PACKETOUTOFBOUNDS_THROTTLE	Throttle reset count for PacketOutOfBounds.
EVENTID_PACKETOUTOFORDER_THROTTLE	Throttle reset count for PacketOutOfOrder.
EVENTID_PACKETDUPLICATE_THROTTLE	Throttle reset count for PacketDuplicate.

Definition at line 96 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_FILESRECEIVED	Channel ID for FilesReceived.
CHANNELID_PACKETSRECEIVED	Channel ID for PacketsReceived.
CHANNELID_WARNINGS	Channel ID for Warnings.

Definition at line 105 of file FileUplinkComponentAc.hpp.

Constructor & Destructor Documentation

◆ FileUplinkComponentBase()

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

protected

Construct FileUplinkComponentBase object.

Parameters

compName The component name

Definition at line 560 of file FileUplinkComponentAc.cpp.

◆ ~FileUplinkComponentBase()

Svc::FileUplinkComponentBase::~FileUplinkComponentBase ( )

protectedvirtual

Destroy FileUplinkComponentBase object.

Definition at line 571 of file FileUplinkComponentAc.cpp.

Member Function Documentation

◆ bufferSendIn_handler()

virtual void Svc::FileUplinkComponentBase::bufferSendIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferSendIn_handlerBase()

void Svc::FileUplinkComponentBase::bufferSendIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 680 of file FileUplinkComponentAc.cpp.

◆ bufferSendIn_preMsgHook()

void Svc::FileUplinkComponentBase::bufferSendIn_preMsgHook	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedvirtual

Pre-message hook for async input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 794 of file FileUplinkComponentAc.cpp.

◆ bufferSendOut_out()

void Svc::FileUplinkComponentBase::bufferSendOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)		const

protected

Invoke output port bufferSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 818 of file FileUplinkComponentAc.cpp.

◆ fileAnnounce_out()

void Svc::FileUplinkComponentBase::fileAnnounce_out	(	FwIndexType	portNum,
		Fw::StringBase &	file_name
	)		const

protected

Invoke output port fileAnnounce.

Parameters

portNum	The port number
file_name	The successfully uplinked file

Definition at line 838 of file FileUplinkComponentAc.cpp.

◆ get_bufferSendIn_InputPort()

Fw::InputBufferSendPort * Svc::FileUplinkComponentBase::get_bufferSendIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferSendIn[portNum]

Parameters

portNum The port number

Definition at line 296 of file FileUplinkComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::FileUplinkComponentBase::get_pingIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 307 of file FileUplinkComponentAc.cpp.

◆ getNum_bufferSendIn_InputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_bufferSendIn_InputPorts ( )

inlinestaticprotected

Get the number of bufferSendIn input ports

Returns: The number of bufferSendIn input ports

Definition at line 302 of file FileUplinkComponentAc.hpp.

◆ getNum_bufferSendOut_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_bufferSendOut_OutputPorts ( )

inlinestaticprotected

Get the number of bufferSendOut output ports

Returns: The number of bufferSendOut output ports

Definition at line 360 of file FileUplinkComponentAc.hpp.

◆ getNum_eventOut_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_eventOut_OutputPorts ( )

inlinestaticprotected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 333 of file FileUplinkComponentAc.hpp.

◆ getNum_fileAnnounce_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_fileAnnounce_OutputPorts ( )

inlinestaticprotected

Get the number of fileAnnounce output ports

Returns: The number of fileAnnounce output ports

Definition at line 367 of file FileUplinkComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_pingIn_InputPorts ( )

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 309 of file FileUplinkComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_pingOut_OutputPorts ( )

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 374 of file FileUplinkComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 340 of file FileUplinkComponentAc.hpp.

◆ getNum_tlmOut_OutputPorts()

static constexpr FwIndexType Svc::FileUplinkComponentBase::getNum_tlmOut_OutputPorts ( )

inlinestaticprotected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 347 of file FileUplinkComponentAc.hpp.

◆ getTime()

Fw::Time Svc::FileUplinkComponentBase::getTime ( ) const

protected

Get the time

\return The current time

Definition at line 2016 of file FileUplinkComponentAc.cpp.

◆ init()

void Svc::FileUplinkComponentBase::init	(	FwSizeType	queueDepth,
		FwEnumStoreType	instance = `0`
	)

Initialize FileUplinkComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 71 of file FileUplinkComponentAc.cpp.

◆ isConnected_bufferSendOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_bufferSendOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port bufferSendOut is connected

Returns: Whether port bufferSendOut is connected

Parameters

portNum The port number

Definition at line 639 of file FileUplinkComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_eventOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 598 of file FileUplinkComponentAc.cpp.

◆ isConnected_fileAnnounce_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_fileAnnounce_OutputPort ( FwIndexType portNum ) const

protected

Check whether port fileAnnounce is connected

Returns: Whether port fileAnnounce is connected

Parameters

portNum The port number

Definition at line 650 of file FileUplinkComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_pingOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 661 of file FileUplinkComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum ) const

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 609 of file FileUplinkComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 620 of file FileUplinkComponentAc.cpp.

◆ log_ACTIVITY_HI_FileReceived()

void Svc::FileUplinkComponentBase::log_ACTIVITY_HI_FileReceived ( const Fw::StringBase & fileName ) const

protected

Log event FileReceived

The File Uplink component successfully received a file

Parameters

fileName The name of the file

Definition at line 1072 of file FileUplinkComponentAc.cpp.

◆ log_ACTIVITY_HI_UplinkCanceled()

void Svc::FileUplinkComponentBase::log_ACTIVITY_HI_UplinkCanceled ( ) const

protected

Log event UplinkCanceled

The File Uplink component received a CANCEL packet

Definition at line 1643 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_BadChecksum()

void Svc::FileUplinkComponentBase::log_WARNING_HI_BadChecksum	(	const Fw::StringBase &	fileName,
		U32	computed,
		U32	read
	)		const

protected

Log event BadChecksum

During receipt of a file, the computed checksum value did not match the stored value

Parameters

fileName	The file name
computed	The computed value
read	The value read

Definition at line 884 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_DecodeError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_DecodeError ( I32 status ) const

protected

Log event DecodeError

Error decoding file packet

Parameters

status The sequence index of the out-of-order packet

Definition at line 1708 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileOpenError ( const Fw::StringBase & fileName ) const

protected

Log event FileOpenError

An error occurred opening a file

Parameters

fileName The name of the file

Definition at line 997 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileWriteError ( const Fw::StringBase & fileName )

protected

Log event FileWriteError

An error occurred writing to a file

Parameters

fileName The name of the file

Definition at line 1147 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileWriteError_ThrottleClear ( )

protected

Reset throttle value for FileWriteError.

Definition at line 1876 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_InvalidPacketReceived()

void Svc::FileUplinkComponentBase::log_WARNING_HI_InvalidPacketReceived ( FwPacketDescriptorType packetType ) const

protected

Log event InvalidPacketReceived

Invalid packet received

Parameters

packetType The packet type received

Definition at line 1790 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_InvalidReceiveMode()

void Svc::FileUplinkComponentBase::log_WARNING_HI_InvalidReceiveMode	(	FwPacketDescriptorType	packetType,
		U32	mode
	)

protected

Log event InvalidReceiveMode

The File Uplink component received a packet with a type that was invalid for the current receive mode

Parameters

packetType	The type of the packet received
mode	The receive mode

Definition at line 1230 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_InvalidReceiveMode_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_InvalidReceiveMode_ThrottleClear ( )

protected

Reset throttle value for InvalidReceiveMode.

Definition at line 1883 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketDuplicate()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketDuplicate ( U32 packetIndex )

protected

Log event PacketDuplicate

The File Uplink component encountered a duplicate packet during file receipt

Parameters

packetIndex The sequence index of the duplicate packet

Definition at line 1553 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketDuplicate_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketDuplicate_ThrottleClear ( )

protected

Reset throttle value for PacketDuplicate.

Definition at line 1904 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfBounds()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfBounds	(	U32	packetIndex,
		const Fw::StringBase &	fileName
	)

protected

Log event PacketOutOfBounds

During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file

Parameters

packetIndex	The sequence index of the packet
fileName	The name of the file

Definition at line 1340 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfBounds_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfBounds_ThrottleClear ( )

protected

Reset throttle value for PacketOutOfBounds.

Definition at line 1890 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfOrder()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfOrder	(	U32	packetIndex,
		U32	lastPacketIndex
	)

protected

Log event PacketOutOfOrder

The File Uplink component encountered an out-of-order packet during file receipt

Parameters

packetIndex	The sequence index of the out-of-order packet
lastPacketIndex	The sequence index of the last packet received before the out-of-order packet

Definition at line 1443 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfOrder_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfOrder_ThrottleClear ( )

protected

Reset throttle value for PacketOutOfOrder.

Definition at line 1897 of file FileUplinkComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::FileUplinkComponentBase::pingIn_handler	(	FwIndexType	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::FileUplinkComponentBase::pingIn_handlerBase	(	FwIndexType	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 733 of file FileUplinkComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::FileUplinkComponentBase::pingIn_preMsgHook	(	FwIndexType	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 803 of file FileUplinkComponentAc.cpp.

◆ pingOut_out()

void Svc::FileUplinkComponentBase::pingOut_out	(	FwIndexType	portNum,
		U32	key
	)		const

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 858 of file FileUplinkComponentAc.cpp.

◆ set_bufferSendOut_OutputPort()

void Svc::FileUplinkComponentBase::set_bufferSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 394 of file FileUplinkComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::FileUplinkComponentBase::set_eventOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 344 of file FileUplinkComponentAc.cpp.

◆ set_fileAnnounce_OutputPort()

void Svc::FileUplinkComponentBase::set_fileAnnounce_OutputPort	(	FwIndexType	portNum,
		Svc::InputFileAnnouncePort *	port
	)

Connect port to fileAnnounce[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 408 of file FileUplinkComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::FileUplinkComponentBase::set_pingOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputPingPort *	port
	)

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 422 of file FileUplinkComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::FileUplinkComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 358 of file FileUplinkComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::FileUplinkComponentBase::set_tlmOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 372 of file FileUplinkComponentAc.cpp.

◆ tlmWrite()

void Svc::FileUplinkComponentBase::tlmWrite	(	FwChanIdType	id,
		Fw::TlmBuffer &	_tlmBuff,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written

Parameters

id	The channel id
_tlmBuff	The serialized telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1915 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_FilesReceived()

void Svc::FileUplinkComponentBase::tlmWrite_FilesReceived	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel FilesReceived

The total number of complete files received

Parameters

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

Definition at line 1946 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_PacketsReceived()

void Svc::FileUplinkComponentBase::tlmWrite_PacketsReceived	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel PacketsReceived

The total number of packets received

Parameters

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

Definition at line 1968 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_Warnings()

void Svc::FileUplinkComponentBase::tlmWrite_Warnings	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel Warnings

The total number of warnings issued

Parameters

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

Definition at line 1990 of file FileUplinkComponentAc.cpp.

Friends And Related Function Documentation

◆ FileUplinkTester

friend class FileUplinkTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 51 of file FileUplinkComponentAc.hpp.

◆ FileUplinkTesterBase

friend class FileUplinkTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 49 of file FileUplinkComponentAc.hpp.

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

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

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FileUplinkComponentBase()

◆ ~FileUplinkComponentBase()

Member Function Documentation

◆ bufferSendIn_handler()

◆ bufferSendIn_handlerBase()

◆ bufferSendIn_preMsgHook()

◆ bufferSendOut_out()

◆ fileAnnounce_out()

◆ get_bufferSendIn_InputPort()

◆ get_pingIn_InputPort()

◆ getNum_bufferSendIn_InputPorts()

◆ getNum_bufferSendOut_OutputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_fileAnnounce_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_bufferSendOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_fileAnnounce_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_HI_FileReceived()

◆ log_ACTIVITY_HI_UplinkCanceled()

◆ log_WARNING_HI_BadChecksum()

◆ log_WARNING_HI_DecodeError()

◆ log_WARNING_HI_FileOpenError()

◆ log_WARNING_HI_FileWriteError()

◆ log_WARNING_HI_FileWriteError_ThrottleClear()

◆ log_WARNING_HI_InvalidPacketReceived()

◆ log_WARNING_HI_InvalidReceiveMode()

◆ log_WARNING_HI_InvalidReceiveMode_ThrottleClear()

◆ log_WARNING_HI_PacketDuplicate()

◆ log_WARNING_HI_PacketDuplicate_ThrottleClear()

◆ log_WARNING_HI_PacketOutOfBounds()

◆ log_WARNING_HI_PacketOutOfBounds_ThrottleClear()

◆ log_WARNING_HI_PacketOutOfOrder()

◆ log_WARNING_HI_PacketOutOfOrder_ThrottleClear()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ set_bufferSendOut_OutputPort()

◆ set_eventOut_OutputPort()

◆ set_fileAnnounce_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ set_tlmOut_OutputPort()

◆ tlmWrite()

◆ tlmWrite_FilesReceived()

◆ tlmWrite_PacketsReceived()

◆ tlmWrite_Warnings()

Friends And Related Function Documentation

◆ FileUplinkTester

◆ FileUplinkTesterBase