#include <Svc/TlmPacketizer/TlmPacketizer.hpp>

Inheritance diagram for Svc::TlmPacketizer:

Public Member Functions
	TlmPacketizer (const char *const compName)

void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance=0)

void	setPacketList (const TlmPacketizerPacketList &packetList, const Svc::TlmPacketizerPacket &ignoreList, const NATIVE_UINT_TYPE startLevel)

	~TlmPacketizer (void)

Public Member Functions inherited from Svc::TlmPacketizerComponentBase
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize TlmPacketizerComponentBase object.

Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputSchedPort *	get_Run_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputTlmPort *	get_TlmRecv_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum].

void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum].

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

void	set_timeGetOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeGetOut[portNum].

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

void	set_PktSend_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputComPort *port)
	Connect port to PktSend[portNum].

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

void	regCommands ()
	Register commands with the Command Dispatcher.

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::TlmPacketizerComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_RUN_INPUT_PORTS = 1 , NUM_TLMRECV_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1 , NUM_TIMEGETOUT_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_PKTSEND_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_SET_LEVEL = 0x0 , OPCODE_SEND_PKT = 0x1 }
	Command opcodes. More...

enum	{ EVENTID_NOCHAN = 0x0 , EVENTID_LEVELSET = 0x1 , EVENTID_MAXLEVELEXCEED = 0x2 , EVENTID_PACKETSENT = 0x3 , EVENTID_PACKETNOTFOUND = 0x4 }
	Event IDs. More...

enum	{ CHANNELID_SENDLEVEL = 0x0 }
	Channel IDs. More...

Protected Member Functions inherited from Svc::TlmPacketizerComponentBase
	TlmPacketizerComponentBase (const char *compName="")
	Construct TlmPacketizerComponentBase object.

virtual	~TlmPacketizerComponentBase ()
	Destroy TlmPacketizerComponentBase object.

NATIVE_INT_TYPE	getNum_cmdIn_InputPorts ()

NATIVE_INT_TYPE	getNum_Run_InputPorts ()

NATIVE_INT_TYPE	getNum_TlmRecv_InputPorts ()

NATIVE_INT_TYPE	getNum_pingIn_InputPorts ()

NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts ()

NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts ()

NATIVE_INT_TYPE	getNum_eventOut_OutputPorts ()

NATIVE_INT_TYPE	getNum_timeGetOut_OutputPorts ()

NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts ()

NATIVE_INT_TYPE	getNum_PktSend_OutputPorts ()

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts ()

bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_timeGetOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_PktSend_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

void	Run_handlerBase (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Handler base-class function for input port Run.

void	TlmRecv_handlerBase (NATIVE_INT_TYPE portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
	Handler base-class function for input port TlmRecv.

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

virtual void	Run_preMsgHook (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
	Pre-message hook for async input port Run.

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

void	PktSend_out (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port PktSend.

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	Invoke output port pingOut.

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response.

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

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

virtual void	SET_LEVEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SET_LEVEL.

virtual void	SEND_PKT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SEND_PKT.

void	log_WARNING_LO_NoChan (U32 Id)

void	log_ACTIVITY_HI_LevelSet (U32 id)

void	log_WARNING_LO_MaxLevelExceed (U32 level, U32 max)

void	log_ACTIVITY_LO_PacketSent (U32 id)

void	log_WARNING_LO_PacketNotFound (U32 id)

void	tlmWrite_SendLevel (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 21 of file TlmPacketizer.hpp.

Constructor & Destructor Documentation

◆ TlmPacketizer()

Svc::TlmPacketizer::TlmPacketizer ( const char *const compName )

Construct object TlmPacketizer

Parameters

compName The component name

Definition at line 21 of file TlmPacketizer.cpp.

◆ ~TlmPacketizer()

Svc::TlmPacketizer::~TlmPacketizer ( void )

Destroy object TlmPacketizer

Definition at line 54 of file TlmPacketizer.cpp.

Member Function Documentation

◆ init()

void Svc::TlmPacketizer::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance = 0 )

Initialize object TlmPacketizer

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 50 of file TlmPacketizer.cpp.

◆ setPacketList()

void Svc::TlmPacketizer::setPacketList	(	const TlmPacketizerPacketList &	packetList,
		const Svc::TlmPacketizerPacket &	ignoreList,
		const NATIVE_UINT_TYPE	startLevel )

Definition at line 56 of file TlmPacketizer.cpp.

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

Svc/TlmPacketizer/TlmPacketizer.hpp
Svc/TlmPacketizer/TlmPacketizer.cpp

Public Member Functions