#include <Svc/FileUplink/FileUplink.hpp>

Inheritance diagram for Svc::FileUplink:

Public Member Functions
	FileUplink (const char *const name)

	~FileUplink ()

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

Friends
class	FileUplinkTester

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

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

Protected Types inherited from Svc::FileUplinkComponentBase
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 inherited from Svc::FileUplinkComponentBase
	FileUplinkComponentBase (const char *compName="")
	Construct FileUplinkComponentBase object. More...

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

bool	isConnected_eventOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

bool	isConnected_bufferSendOut_OutputPort (FwIndexType portNum)

bool	isConnected_fileAnnounce_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

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)
	Invoke output port bufferSendOut. More...

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

void	pingOut_out (FwIndexType portNum, U32 key)
	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_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 inherited from Svc::FileUplinkComponentBase
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 ()

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

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 24 of file FileUplink.cpp.

◆ ~FileUplink()

Svc::FileUplink::~FileUplink ( )

Destroy object FileUplink

Definition at line 33 of file FileUplink.cpp.

Friends And Related Function Documentation

◆ FileUplinkTester

friend class FileUplinkTester

friend

Definition at line 23 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