Svc::FileUplink Class Reference

#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 ()
Public Member Functions inherited from Svc::FileUplinkComponentBase
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize FileUplinkComponentBase object.
Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)
void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum].
void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum].
void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum].
void	set_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOut[portNum].
void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum].
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
	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
void	exit ()
	exit task in active component
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
U32	getIdBase () const

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_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_UPLINKCANCELED = 0x7 ,   EVENTID_DECODEERROR = 0x8 }
	Event IDs. More...
enum	{ EVENTID_FILEWRITEERROR_THROTTLE = 5 , EVENTID_INVALIDRECEIVEMODE_THROTTLE = 5 , EVENTID_PACKETOUTOFBOUNDS_THROTTLE = 5 , EVENTID_PACKETOUTOFORDER_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 Member Functions inherited from Svc::FileUplinkComponentBase
	FileUplinkComponentBase (const char *compName="")
	Construct FileUplinkComponentBase object.
virtual	~FileUplinkComponentBase ()
	Destroy FileUplinkComponentBase object.
NATIVE_INT_TYPE	getNum_bufferSendIn_InputPorts ()
NATIVE_INT_TYPE	getNum_pingIn_InputPorts ()
NATIVE_INT_TYPE	getNum_eventOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts ()
NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_bufferSendOut_OutputPorts ()
NATIVE_INT_TYPE	getNum_pingOut_OutputPorts ()
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_bufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
void	bufferSendIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendIn.
void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn.
virtual void	bufferSendIn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendIn.
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn.
void	bufferSendOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOut.
void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port pingOut.
void	log_WARNING_HI_BadChecksum (const Fw::LogStringArg &fileName, U32 computed, U32 read)
void	log_WARNING_HI_FileOpenError (const Fw::LogStringArg &fileName)
void	log_ACTIVITY_HI_FileReceived (const Fw::LogStringArg &fileName)
void	log_WARNING_HI_FileWriteError (const Fw::LogStringArg &fileName)
void	log_WARNING_HI_InvalidReceiveMode (U32 packetType, U32 mode)
void	log_WARNING_HI_PacketOutOfBounds (U32 packetIndex, const Fw::LogStringArg &fileName)
void	log_WARNING_HI_PacketOutOfOrder (U32 packetIndex, U32 lastPacketIndex)
void	log_ACTIVITY_HI_UplinkCanceled ()
void	log_WARNING_HI_DecodeError (I32 status)
void	log_WARNING_HI_FileWriteError_ThrottleClear ()
	Reset throttle value for FileWriteError.
void	log_WARNING_HI_InvalidReceiveMode_ThrottleClear ()
	Reset throttle value for InvalidReceiveMode.
void	log_WARNING_HI_PacketOutOfBounds_ThrottleClear ()
	Reset throttle value for PacketOutOfBounds.
void	log_WARNING_HI_PacketOutOfOrder_ThrottleClear ()
	Reset throttle value for PacketOutOfOrder.
void	tlmWrite_FilesReceived (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_PacketsReceived (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_Warnings (U32 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime ()
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor.
virtual	~ActiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization code
virtual void	preamble ()
	A function that will be called before the event loop is entered.
virtual void	loop ()
	The function that will loop dispatching messages.
virtual void	finalizer ()
	A function that will be called after exiting the loop.
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor.
virtual	~QueuedComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization function
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped
void	incNumMsgDropped ()
	increment the number of messages dropped
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.
Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

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

(

)

Destroy object FileUplink

Definition at line 44 of file FileUplink.cpp.

Member Function Documentation

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.

---

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

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