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

#include <Svc/TlmPacketizer/TlmPacketizerComponentAc.hpp>

Inheritance diagram for Svc::TlmPacketizerComponentBase:

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

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_Run_InputPort (FwIndexType portNum)

Fw::InputTlmPort *	get_TlmRecv_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

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

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

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

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

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

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

void	set_pingOut_OutputPort (FwIndexType 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 (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started

void	exit ()
	exit task in active component

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

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

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

U32	getIdBase () const

Protected Types
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 Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
	Tracks the lifecycle of the component. More...

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

virtual	~TlmPacketizerComponentBase ()
	Destroy TlmPacketizerComponentBase object.

FwIndexType	getNum_cmdIn_InputPorts () const

FwIndexType	getNum_Run_InputPorts () const

FwIndexType	getNum_TlmRecv_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_cmdRegOut_OutputPorts () const

FwIndexType	getNum_cmdResponseOut_OutputPorts () const

FwIndexType	getNum_eventOut_OutputPorts () const

FwIndexType	getNum_timeGetOut_OutputPorts () const

FwIndexType	getNum_tlmOut_OutputPorts () const

FwIndexType	getNum_PktSend_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum)

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)

bool	isConnected_eventOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeGetOut_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

bool	isConnected_PktSend_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

virtual void	Run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port Run.

virtual void	TlmRecv_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0
	Handler for input port TlmRecv.

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

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

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

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

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

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

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

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

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

virtual void	SET_LEVEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 level)=0

virtual void	SEND_PKT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 id)=0

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) const

void	log_ACTIVITY_HI_LevelSet (U32 id) const

void	log_WARNING_LO_MaxLevelExceed (U32 level, U32 max) const

void	log_ACTIVITY_LO_PacketSent (U32 id) const

void	log_WARNING_LO_PacketNotFound (U32 id) const

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

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.

MsgDispatchStatus	dispatch ()
	The function that will 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::Status	createQueue (FwSizeType depth, FwSizeType 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.

Friends
class	TlmPacketizerComponentBaseFriend
	Friend class for white-box testing.

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

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Auto-generated base for TlmPacketizer component.

A component for storing telemetry

Definition at line 36 of file TlmPacketizerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 54 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_RUN_INPUT_PORTS
NUM_TLMRECV_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 59 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMEGETOUT_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 66 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PKTSEND_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 76 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_SET_LEVEL	Set telemetry send level.
OPCODE_SEND_PKT	Force a packet to be sent.

Definition at line 82 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_NOCHAN	Telemetry channel is not part of a telemetry packet.
EVENTID_LEVELSET	Telemetry send level set.
EVENTID_MAXLEVELEXCEED	Telemetry send level set.
EVENTID_PACKETSENT	Packet manually sent.
EVENTID_PACKETNOTFOUND	Couldn't find the packet to send.

Definition at line 88 of file TlmPacketizerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_SENDLEVEL	Channel ID for SendLevel.

Definition at line 97 of file TlmPacketizerComponentAc.hpp.

Constructor & Destructor Documentation

◆ TlmPacketizerComponentBase()

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

protected

Construct TlmPacketizerComponentBase object.

Parameters

compName The component name

Definition at line 673 of file TlmPacketizerComponentAc.cpp.

◆ ~TlmPacketizerComponentBase()

Svc::TlmPacketizerComponentBase::~TlmPacketizerComponentBase ( )

protectedvirtual

Destroy TlmPacketizerComponentBase object.

Definition at line 680 of file TlmPacketizerComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::TlmPacketizerComponentBase::cmdResponse_out	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdResponse	response
	)

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 1079 of file TlmPacketizerComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::TlmPacketizerComponentBase::get_cmdIn_InputPort ( FwIndexType portNum )

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 347 of file TlmPacketizerComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 384 of file TlmPacketizerComponentAc.cpp.

◆ get_Run_InputPort()

Svc::InputSchedPort * Svc::TlmPacketizerComponentBase::get_Run_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: Run[portNum]

Parameters

portNum The port number

Definition at line 362 of file TlmPacketizerComponentAc.cpp.

◆ get_TlmRecv_InputPort()

Fw::InputTlmPort * Svc::TlmPacketizerComponentBase::get_TlmRecv_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: TlmRecv[portNum]

Parameters

portNum The port number

Definition at line 373 of file TlmPacketizerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 690 of file TlmPacketizerComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 722 of file TlmPacketizerComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 728 of file TlmPacketizerComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 734 of file TlmPacketizerComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 712 of file TlmPacketizerComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 772 of file TlmPacketizerComponentAc.cpp.

◆ getNum_PktSend_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_PktSend_OutputPorts ( ) const

protected

Get the number of PktSend output ports

Returns: The number of PktSend output ports

Definition at line 766 of file TlmPacketizerComponentAc.cpp.

◆ getNum_Run_InputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_Run_InputPorts ( ) const

protected

Get the number of Run input ports

Returns: The number of Run input ports

Definition at line 700 of file TlmPacketizerComponentAc.cpp.

◆ getNum_timeGetOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_timeGetOut_OutputPorts ( ) const

protected

Get the number of timeGetOut output ports

Returns: The number of timeGetOut output ports

Definition at line 750 of file TlmPacketizerComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 756 of file TlmPacketizerComponentAc.cpp.

◆ getNum_TlmRecv_InputPorts()

FwIndexType Svc::TlmPacketizerComponentBase::getNum_TlmRecv_InputPorts ( ) const

protected

Get the number of TlmRecv input ports

Returns: The number of TlmRecv input ports

Definition at line 706 of file TlmPacketizerComponentAc.cpp.

◆ getTime()

Fw::Time Svc::TlmPacketizerComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 1719 of file TlmPacketizerComponentAc.cpp.

◆ init()

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

Initialize TlmPacketizerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 73 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 782 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 793 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_eventOut_OutputPort ( FwIndexType portNum )

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 804 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType portNum )

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 867 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_PktSend_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_PktSend_OutputPort ( FwIndexType portNum )

protected

Check whether port PktSend is connected

Returns: Whether port PktSend is connected

Parameters

portNum The port number

Definition at line 856 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_timeGetOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_timeGetOut_OutputPort ( FwIndexType portNum )

protected

Check whether port timeGetOut is connected

Returns: Whether port timeGetOut is connected

Parameters

portNum The port number

Definition at line 830 of file TlmPacketizerComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum )

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 841 of file TlmPacketizerComponentAc.cpp.

◆ log_ACTIVITY_HI_LevelSet()

void Svc::TlmPacketizerComponentBase::log_ACTIVITY_HI_LevelSet ( U32 id ) const

protected

Log event LevelSet

Telemetry send level set

Parameters

id The level

Definition at line 1330 of file TlmPacketizerComponentAc.cpp.

◆ log_ACTIVITY_LO_PacketSent()

void Svc::TlmPacketizerComponentBase::log_ACTIVITY_LO_PacketSent ( U32 id ) const

protected

Log event PacketSent

Packet manually sent

Parameters

id	The packet ID

Definition at line 1514 of file TlmPacketizerComponentAc.cpp.

◆ log_WARNING_LO_MaxLevelExceed()

void Svc::TlmPacketizerComponentBase::log_WARNING_LO_MaxLevelExceed	(	U32	level,
		U32	max
	)		const

protected

Log event MaxLevelExceed

Telemetry send level set

Parameters

level	The level
max	The max packet level

Definition at line 1412 of file TlmPacketizerComponentAc.cpp.

◆ log_WARNING_LO_NoChan()

void Svc::TlmPacketizerComponentBase::log_WARNING_LO_NoChan ( U32 Id ) const

protected

Log event NoChan

Telemetry channel is not part of a telemetry packet.

Parameters

Id	The telemetry ID

Definition at line 1248 of file TlmPacketizerComponentAc.cpp.

◆ log_WARNING_LO_PacketNotFound()

void Svc::TlmPacketizerComponentBase::log_WARNING_LO_PacketNotFound ( U32 id ) const

protected

Log event PacketNotFound

Couldn't find the packet to send

Parameters

id	The packet ID

Definition at line 1596 of file TlmPacketizerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::TlmPacketizerComponentBase::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::TlmPacketizerComponentBase::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 960 of file TlmPacketizerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::TlmPacketizerComponentBase::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 1030 of file TlmPacketizerComponentAc.cpp.

◆ pingOut_out()

void Svc::TlmPacketizerComponentBase::pingOut_out	(	FwIndexType	portNum,
		U32	key
	)

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1060 of file TlmPacketizerComponentAc.cpp.

◆ PktSend_out()

void Svc::TlmPacketizerComponentBase::PktSend_out	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Invoke output port PktSend.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1043 of file TlmPacketizerComponentAc.cpp.

◆ regCommands()

void Svc::TlmPacketizerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 655 of file TlmPacketizerComponentAc.cpp.

◆ Run_handler()

virtual void Svc::TlmPacketizerComponentBase::Run_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port Run.

Parameters

portNum	The port number
context	The call order

◆ Run_handlerBase()

void Svc::TlmPacketizerComponentBase::Run_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port Run.

Parameters

portNum	The port number
context	The call order

Definition at line 884 of file TlmPacketizerComponentAc.cpp.

◆ Run_preMsgHook()

void Svc::TlmPacketizerComponentBase::Run_preMsgHook	(	FwIndexType	portNum,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port Run.

Parameters

portNum	The port number
context	The call order

Definition at line 1021 of file TlmPacketizerComponentAc.cpp.

◆ SEND_PKT_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::SEND_PKT_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		U32	id
	)

protectedpure virtual

Handler for command SEND_PKT

Force a packet to be sent

Parameters

opCode	The opcode
cmdSeq	The command sequence number
id	The packet ID

◆ SEND_PKT_cmdHandlerBase()

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

protected

Base-class handler function for command SEND_PKT

Force a packet to be sent

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1155 of file TlmPacketizerComponentAc.cpp.

◆ SEND_PKT_preMsgHook()

void Svc::TlmPacketizerComponentBase::SEND_PKT_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command SEND_PKT.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1233 of file TlmPacketizerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::TlmPacketizerComponentBase::set_cmdRegOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 399 of file TlmPacketizerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::TlmPacketizerComponentBase::set_cmdResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 413 of file TlmPacketizerComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::TlmPacketizerComponentBase::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 427 of file TlmPacketizerComponentAc.cpp.

◆ SET_LEVEL_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::SET_LEVEL_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		U32	level
	)

protectedpure virtual

Handler for command SET_LEVEL

Set telemetry send level

Parameters

opCode	The opcode
cmdSeq	The command sequence number
level	The I32 command argument

◆ SET_LEVEL_cmdHandlerBase()

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

protected

Base-class handler function for command SET_LEVEL

Set telemetry send level

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1096 of file TlmPacketizerComponentAc.cpp.

◆ SET_LEVEL_preMsgHook()

void Svc::TlmPacketizerComponentBase::SET_LEVEL_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command SET_LEVEL.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1222 of file TlmPacketizerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::TlmPacketizerComponentBase::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 505 of file TlmPacketizerComponentAc.cpp.

◆ set_PktSend_OutputPort()

void Svc::TlmPacketizerComponentBase::set_PktSend_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to PktSend[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 491 of file TlmPacketizerComponentAc.cpp.

◆ set_timeGetOut_OutputPort()

void Svc::TlmPacketizerComponentBase::set_timeGetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeGetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 459 of file TlmPacketizerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::TlmPacketizerComponentBase::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 473 of file TlmPacketizerComponentAc.cpp.

◆ TlmRecv_handler()

virtual void Svc::TlmPacketizerComponentBase::TlmRecv_handler	(	FwIndexType	portNum,
		FwChanIdType	id,
		Fw::Time &	timeTag,
		Fw::TlmBuffer &	val
	)

protectedpure virtual

Handler for input port TlmRecv.

Parameters

portNum	The port number
id	Telemetry Channel ID
timeTag	Time Tag
val	Buffer containing serialized telemetry value

◆ TlmRecv_handlerBase()

void Svc::TlmPacketizerComponentBase::TlmRecv_handlerBase	(	FwIndexType	portNum,
		FwChanIdType	id,
		Fw::Time &	timeTag,
		Fw::TlmBuffer &	val
	)

protected

Handler base-class function for input port TlmRecv.

Parameters

portNum	The port number
id	Telemetry Channel ID
timeTag	Time Tag
val	Buffer containing serialized telemetry value

Definition at line 937 of file TlmPacketizerComponentAc.cpp.

◆ tlmWrite_SendLevel()

void Svc::TlmPacketizerComponentBase::tlmWrite_SendLevel	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel SendLevel

Telemetry send level

Parameters

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

Definition at line 1682 of file TlmPacketizerComponentAc.cpp.

Friends And Related Symbol Documentation

◆ TlmPacketizerComponentBaseFriend

friend class TlmPacketizerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 45 of file TlmPacketizerComponentAc.hpp.

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

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

Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ TlmPacketizerComponentBase()

◆ ~TlmPacketizerComponentBase()

Member Function Documentation

◆ cmdResponse_out()

◆ get_cmdIn_InputPort()

◆ get_pingIn_InputPort()

◆ get_Run_InputPort()

◆ get_TlmRecv_InputPort()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_PktSend_OutputPorts()

◆ getNum_Run_InputPorts()

◆ getNum_timeGetOut_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getNum_TlmRecv_InputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_PktSend_OutputPort()

◆ isConnected_timeGetOut_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_HI_LevelSet()

◆ log_ACTIVITY_LO_PacketSent()

◆ log_WARNING_LO_MaxLevelExceed()

◆ log_WARNING_LO_NoChan()

◆ log_WARNING_LO_PacketNotFound()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ PktSend_out()

◆ regCommands()

◆ Run_handler()

◆ Run_handlerBase()

◆ Run_preMsgHook()

◆ SEND_PKT_cmdHandler()

◆ SEND_PKT_cmdHandlerBase()

◆ SEND_PKT_preMsgHook()

◆ set_cmdRegOut_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_eventOut_OutputPort()

◆ SET_LEVEL_cmdHandler()

◆ SET_LEVEL_cmdHandlerBase()

◆ SET_LEVEL_preMsgHook()

◆ set_pingOut_OutputPort()

◆ set_PktSend_OutputPort()

◆ set_timeGetOut_OutputPort()

◆ set_tlmOut_OutputPort()

◆ TlmRecv_handler()

◆ TlmRecv_handlerBase()

◆ tlmWrite_SendLevel()

Friends And Related Symbol Documentation

◆ TlmPacketizerComponentBaseFriend