Svc::TlmPacketizerComponentBase Class Reference

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. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Svc::InputSchedPort *	get_Run_InputPort (FwIndexType portNum)
Fw::InputTlmGetPort *	get_TlmGet_InputPort (FwIndexType portNum)
Fw::InputTlmPort *	get_TlmRecv_InputPort (FwIndexType portNum)
Svc::InputConfigureGroupRatePort *	get_configureSectionGroupRate_InputPort (FwIndexType portNum)
Svc::InputEnableSectionPort *	get_controlIn_InputPort (FwIndexType portNum)
Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)
void	set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum]. More...
void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...
void	set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...
void	set_paramGetOut_OutputPort (FwIndexType portNum, Fw::InputPrmGetPort *port)
	Connect port to paramGetOut[portNum]. More...
void	set_paramSetOut_OutputPort (FwIndexType portNum, Fw::InputPrmSetPort *port)
	Connect port to paramSetOut[portNum]. More...
void	set_timeGetOut_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeGetOut[portNum]. More...
void	set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum]. More...
void	set_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to PktSend[portNum]. More...
void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
void	loadParameters ()
	Load the parameters from a parameter source. 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_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{   NUM_RUN_INPUT_PORTS = 1, NUM_TLMGET_INPUT_PORTS = 1, NUM_TLMRECV_INPUT_PORTS = 1, NUM_CONFIGURESECTIONGROUPRATE_INPUT_PORTS = 1,   NUM_CONTROLIN_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_PARAMGETOUT_OUTPUT_PORTS = 1,   NUM_PARAMSETOUT_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 = 2, NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{   OPCODE_SET_LEVEL = 0x0, OPCODE_SEND_PKT = 0x1, OPCODE_ENABLE_SECTION = 0x2, OPCODE_ENABLE_GROUP = 0x3,   OPCODE_FORCE_GROUP = 0x4, OPCODE_CONFIGURE_GROUP_RATES = 0x5, OPCODE_SECTION_ENABLED_SET = 0x6, OPCODE_SECTION_ENABLED_SAVE = 0x7,   OPCODE_SECTION_CONFIGS_SET = 0x8, OPCODE_SECTION_CONFIGS_SAVE = 0x9 }
	Command opcodes. More...
enum	{   EVENTID_NOCHAN = 0x0, EVENTID_LEVELSET = 0x1, EVENTID_MAXLEVELEXCEED = 0x2, EVENTID_PACKETSENT = 0x3,   EVENTID_PACKETNOTFOUND = 0x4, EVENTID_SECTIONUNCONFIGURABLE = 0x5 }
	Event IDs. More...
enum	{ CHANNELID_GROUPCONFIGS = 0x0, CHANNELID_SECTIONENABLED = 0x1 }
	Channel IDs. More...
enum	{ PARAMID_SECTION_ENABLED = 0x0, PARAMID_SECTION_CONFIGS = 0x1 }
	Parameter 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. More...
virtual	~TlmPacketizerComponentBase ()
	Destroy TlmPacketizerComponentBase object. More...
bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const
bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const
bool	isConnected_eventOut_OutputPort (FwIndexType portNum) const
bool	isConnected_paramGetOut_OutputPort (FwIndexType portNum) const
bool	isConnected_paramSetOut_OutputPort (FwIndexType portNum) const
bool	isConnected_timeGetOut_OutputPort (FwIndexType portNum) const
bool	isConnected_tlmOut_OutputPort (FwIndexType portNum) const
bool	isConnected_PktSend_OutputPort (FwIndexType portNum) const
bool	isConnected_pingOut_OutputPort (FwIndexType portNum) const
void	cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Handler base-class function for input port cmdIn. More...
virtual void	Run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port Run. More...
virtual Fw::TlmValid	TlmGet_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0
	Handler for input port TlmGet. More...
virtual void	TlmRecv_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0
	Handler for input port TlmRecv. More...
virtual void	configureSectionGroupRate_handler (FwIndexType portNum, const Svc::TelemetrySection &section, FwChanIdType tlmGroup, const Svc::RateLogic &rateLogic, U32 minDelta, U32 maxDelta)=0
	Handler for input port configureSectionGroupRate. More...
virtual void	controlIn_handler (FwIndexType portNum, const Svc::TelemetrySection &section, const Fw::Enabled &enabled)=0
	Handler for input port controlIn. More...
virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...
void	Run_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port Run. More...
Fw::TlmValid	TlmGet_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
	Handler base-class function for input port TlmGet. More...
void	TlmRecv_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
	Handler base-class function for input port TlmRecv. More...
void	configureSectionGroupRate_handlerBase (FwIndexType portNum, const Svc::TelemetrySection &section, FwChanIdType tlmGroup, const Svc::RateLogic &rateLogic, U32 minDelta, U32 maxDelta)
	Handler base-class function for input port configureSectionGroupRate. More...
void	controlIn_handlerBase (FwIndexType portNum, const Svc::TelemetrySection &section, const Fw::Enabled &enabled)
	Handler base-class function for input port controlIn. More...
void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...
virtual void	Run_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port Run. More...
virtual void	configureSectionGroupRate_preMsgHook (FwIndexType portNum, const Svc::TelemetrySection &section, FwChanIdType tlmGroup, const Svc::RateLogic &rateLogic, U32 minDelta, U32 maxDelta)
	Pre-message hook for async input port configureSectionGroupRate. More...
virtual void	controlIn_preMsgHook (FwIndexType portNum, const Svc::TelemetrySection &section, const Fw::Enabled &enabled)
	Pre-message hook for async input port controlIn. More...
virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
void	PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const
	Invoke output port PktSend. More...
void	pingOut_out (FwIndexType portNum, U32 key) const
	Invoke output port pingOut. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
virtual void	SET_LEVEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, FwChanIdType level)=0
virtual void	SEND_PKT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 id, Svc::TelemetrySection section)=0
virtual void	ENABLE_SECTION_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::TelemetrySection section, Fw::Enabled enable)=0
virtual void	ENABLE_GROUP_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::TelemetrySection section, FwChanIdType tlmGroup, Fw::Enabled enable)=0
virtual void	FORCE_GROUP_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::TelemetrySection section, FwChanIdType tlmGroup, Fw::Enabled enable)=0
virtual void	CONFIGURE_GROUP_RATES_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::TelemetrySection section, FwChanIdType tlmGroup, Svc::RateLogic rateLogic, U32 minDelta, U32 maxDelta)=0
void	SET_LEVEL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	SEND_PKT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	ENABLE_SECTION_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	ENABLE_GROUP_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	FORCE_GROUP_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CONFIGURE_GROUP_RATES_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void	SET_LEVEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SET_LEVEL. More...
virtual void	SEND_PKT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SEND_PKT. More...
virtual void	ENABLE_SECTION_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command ENABLE_SECTION. More...
virtual void	ENABLE_GROUP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command ENABLE_GROUP. More...
virtual void	FORCE_GROUP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command FORCE_GROUP. More...
virtual void	CONFIGURE_GROUP_RATES_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CONFIGURE_GROUP_RATES. More...
void	log_WARNING_LO_NoChan (FwChanIdType Id) const
void	log_ACTIVITY_HI_LevelSet (FwChanIdType id) const
void	log_WARNING_LO_MaxLevelExceed (FwChanIdType level, FwChanIdType max) const
void	log_ACTIVITY_LO_PacketSent (U32 id) const
void	log_WARNING_LO_PacketNotFound (U32 id) const
void	log_WARNING_LO_SectionUnconfigurable (Svc::TelemetrySection section, Fw::Enabled enable) const
	Log event SectionUnconfigurable. More...
void	tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_GroupConfigs (const Svc::TlmPacketizer_SectionConfigs &arg, Fw::Time _tlmTime=Fw::Time()) const
void	tlmWrite_SectionEnabled (const Svc::TlmPacketizer_SectionEnabled &arg, Fw::Time _tlmTime=Fw::Time()) const
	Write telemetry channel SectionEnabled. More...
virtual void	parameterUpdated (FwPrmIdType id)
	Called whenever a parameter is updated. More...
virtual void	parametersLoaded ()
	Called whenever parameters are loaded. More...
Svc::TlmPacketizer_SectionEnabled	paramGet_SECTION_ENABLED (Fw::ParamValid &valid)
Svc::TlmPacketizer_SectionConfigs	paramGet_SECTION_CONFIGS (Fw::ParamValid &valid)
void	registerExternalParameters (Fw::ParamExternalDelegate *paramExternalDelegatePtr)
	Initialize the external parameter delegate. More...
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_cmdIn_InputPorts ()
static constexpr FwIndexType	getNum_Run_InputPorts ()
static constexpr FwIndexType	getNum_TlmGet_InputPorts ()
static constexpr FwIndexType	getNum_TlmRecv_InputPorts ()
static constexpr FwIndexType	getNum_configureSectionGroupRate_InputPorts ()
static constexpr FwIndexType	getNum_controlIn_InputPorts ()
static constexpr FwIndexType	getNum_pingIn_InputPorts ()
static constexpr FwIndexType	getNum_cmdRegOut_OutputPorts ()
static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()
static constexpr FwIndexType	getNum_eventOut_OutputPorts ()
static constexpr FwIndexType	getNum_paramGetOut_OutputPorts ()
static constexpr FwIndexType	getNum_paramSetOut_OutputPorts ()
static constexpr FwIndexType	getNum_timeGetOut_OutputPorts ()
static constexpr FwIndexType	getNum_tlmOut_OutputPorts ()
static constexpr FwIndexType	getNum_PktSend_OutputPorts ()
static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

Friends
class	TlmPacketizerTesterBase
	Friend class tester to support autocoded test harness. More...
class	TlmPacketizerTester
	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 TlmPacketizer component.

A component for storing telemetry

Definition at line 60 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 80 of file TlmPacketizerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_RUN_INPUT_PORTS
NUM_TLMGET_INPUT_PORTS
NUM_TLMRECV_INPUT_PORTS
NUM_CONFIGURESECTIONGROUPRATE_INPUT_PORTS
NUM_CONTROLIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 85 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_PARAMGETOUT_OUTPUT_PORTS
NUM_PARAMSETOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMEGETOUT_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 95 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 107 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.
OPCODE_ENABLE_SECTION	Enable / disable a telemetry section.
OPCODE_ENABLE_GROUP	Enable / disable telemetry of a group on a section.
OPCODE_FORCE_GROUP	Force telemetering a group on a section, even if disabled.
OPCODE_CONFIGURE_GROUP_RATES	Set Min and Max Deltas between successive packets.
OPCODE_SECTION_ENABLED_SET	Opcode to set parameter SECTION_ENABLED.
OPCODE_SECTION_ENABLED_SAVE	Opcode to save parameter SECTION_ENABLED.
OPCODE_SECTION_CONFIGS_SET	Opcode to set parameter SECTION_CONFIGS.
OPCODE_SECTION_CONFIGS_SAVE	Opcode to save parameter SECTION_CONFIGS.

Definition at line 113 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.
EVENTID_SECTIONUNCONFIGURABLE

Definition at line 127 of file TlmPacketizerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_GROUPCONFIGS	Channel ID for GroupConfigs.
CHANNELID_SECTIONENABLED	Channel ID for SectionEnabled.

Definition at line 137 of file TlmPacketizerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Parameter IDs.

Enumerator
PARAMID_SECTION_ENABLED	Parameter to control section enable flags.
PARAMID_SECTION_CONFIGS	Parameter to control section configuration.

Definition at line 143 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 1067 of file TlmPacketizerComponentAc.cpp.

~TlmPacketizerComponentBase()

Svc::TlmPacketizerComponentBase::~TlmPacketizerComponentBase ( )

protectedvirtual

Destroy TlmPacketizerComponentBase object.

Definition at line 1074 of file TlmPacketizerComponentAc.cpp.

Member Function Documentation

cmdIn_handlerBase()

void Svc::TlmPacketizerComponentBase::cmdIn_handlerBase ( FwIndexType  portNum, FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Handler base-class function for input port cmdIn.

Parameters

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

Definition at line 1216 of file TlmPacketizerComponentAc.cpp.

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 1745 of file TlmPacketizerComponentAc.cpp.

CONFIGURE_GROUP_RATES_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::CONFIGURE_GROUP_RATES_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, Svc::TelemetrySection  section, FwChanIdType  tlmGroup, Svc::RateLogic  rateLogic, U32  minDelta, U32  maxDelta  )

protectedpure virtual

Handler for command CONFIGURE_GROUP_RATES

Set Min and Max Deltas between successive packets

Parameters

opCode	The opcode
cmdSeq	The command sequence number
section	Section grouping
tlmGroup	Group Identifier
rateLogic	Rate Logic
minDelta	Minimum Sched Ticks to send packets on updates when using ON_CHANGE logic
maxDelta	Maximum Sched Ticks between packets to send when using EVERY_MAX logic

CONFIGURE_GROUP_RATES_cmdHandlerBase()

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

protected

Base-class handler function for command CONFIGURE_GROUP_RATES

Set Min and Max Deltas between successive packets

Parameters

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

Definition at line 2057 of file TlmPacketizerComponentAc.cpp.

CONFIGURE_GROUP_RATES_preMsgHook()

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

protectedvirtual

Pre-message hook for command CONFIGURE_GROUP_RATES.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2179 of file TlmPacketizerComponentAc.cpp.

configureSectionGroupRate_handler()

virtual void Svc::TlmPacketizerComponentBase::configureSectionGroupRate_handler ( FwIndexType  portNum, const Svc::TelemetrySection &  section, FwChanIdType  tlmGroup, const Svc::RateLogic &  rateLogic, U32  minDelta, U32  maxDelta  )

protectedpure virtual

Handler for input port configureSectionGroupRate.

Parameters

portNum	The port number
section	Section grouping
tlmGroup	Group Identifier
rateLogic	Rate Logic
minDelta	Minimum Sched Ticks to send packets on updates when using ON_CHANGE logic
maxDelta	Maximum Sched Ticks between packets to send when using EVERY_MAX logic

configureSectionGroupRate_handlerBase()

void Svc::TlmPacketizerComponentBase::configureSectionGroupRate_handlerBase ( FwIndexType  portNum, const Svc::TelemetrySection &  section, FwChanIdType  tlmGroup, const Svc::RateLogic &  rateLogic, U32  minDelta, U32  maxDelta  )

protected

Handler base-class function for input port configureSectionGroupRate.

Parameters

portNum	The port number
section	Section grouping
tlmGroup	Group Identifier
rateLogic	Rate Logic
minDelta	Minimum Sched Ticks to send packets on updates when using ON_CHANGE logic
maxDelta	Maximum Sched Ticks between packets to send when using EVERY_MAX logic

Definition at line 1438 of file TlmPacketizerComponentAc.cpp.

configureSectionGroupRate_preMsgHook()

void Svc::TlmPacketizerComponentBase::configureSectionGroupRate_preMsgHook ( FwIndexType  portNum, const Svc::TelemetrySection &  section, FwChanIdType  tlmGroup, const Svc::RateLogic &  rateLogic, U32  minDelta, U32  maxDelta  )

protectedvirtual

Pre-message hook for async input port configureSectionGroupRate.

Parameters

portNum	The port number
section	Section grouping
tlmGroup	Group Identifier
rateLogic	Rate Logic
minDelta	Minimum Sched Ticks to send packets on updates when using ON_CHANGE logic
maxDelta	Maximum Sched Ticks between packets to send when using EVERY_MAX logic

Definition at line 1659 of file TlmPacketizerComponentAc.cpp.

controlIn_handler()

virtual void Svc::TlmPacketizerComponentBase::controlIn_handler ( FwIndexType  portNum, const Svc::TelemetrySection &  section, const Fw::Enabled &  enabled  )

protectedpure virtual

Handler for input port controlIn.

Parameters

portNum	The port number
section	Section to enable (Primary, Secondary, etc...)
enabled	Enable / Disable Section

controlIn_handlerBase()

void Svc::TlmPacketizerComponentBase::controlIn_handlerBase ( FwIndexType  portNum, const Svc::TelemetrySection &  section, const Fw::Enabled &  enabled  )

protected

Handler base-class function for input port controlIn.

Parameters

portNum	The port number
section	Section to enable (Primary, Secondary, etc...)
enabled	Enable / Disable Section

Definition at line 1527 of file TlmPacketizerComponentAc.cpp.

controlIn_preMsgHook()

void Svc::TlmPacketizerComponentBase::controlIn_preMsgHook ( FwIndexType  portNum, const Svc::TelemetrySection &  section, const Fw::Enabled &  enabled  )

protectedvirtual

Pre-message hook for async input port controlIn.

Parameters

portNum	The port number
section	Section to enable (Primary, Secondary, etc...)
enabled	Enable / Disable Section

Definition at line 1672 of file TlmPacketizerComponentAc.cpp.

ENABLE_GROUP_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::ENABLE_GROUP_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, Svc::TelemetrySection  section, FwChanIdType  tlmGroup, Fw::Enabled  enable  )

protectedpure virtual

Handler for command ENABLE_GROUP

Enable / disable telemetry of a group on a section

Parameters

opCode	The opcode
cmdSeq	The command sequence number
section	Section grouping to configure
tlmGroup	Group Identifier
enable	Section enabled or disabled

ENABLE_GROUP_cmdHandlerBase()

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

protected

Base-class handler function for command ENABLE_GROUP

Enable / disable telemetry of a group on a section

Parameters

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

Definition at line 1939 of file TlmPacketizerComponentAc.cpp.

ENABLE_GROUP_preMsgHook()

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

protectedvirtual

Pre-message hook for command ENABLE_GROUP.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2157 of file TlmPacketizerComponentAc.cpp.

ENABLE_SECTION_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::ENABLE_SECTION_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, Svc::TelemetrySection  section, Fw::Enabled  enable  )

protectedpure virtual

Handler for command ENABLE_SECTION

Enable / disable a telemetry section

Parameters

opCode	The opcode
cmdSeq	The command sequence number
section	Section grouping to configure
enable	Section enabled or disabled

ENABLE_SECTION_cmdHandlerBase()

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

protected

Base-class handler function for command ENABLE_SECTION

Enable / disable a telemetry section

Parameters

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

Definition at line 1880 of file TlmPacketizerComponentAc.cpp.

ENABLE_SECTION_preMsgHook()

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

protectedvirtual

Pre-message hook for command ENABLE_SECTION.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2146 of file TlmPacketizerComponentAc.cpp.

FORCE_GROUP_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::FORCE_GROUP_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, Svc::TelemetrySection  section, FwChanIdType  tlmGroup, Fw::Enabled  enable  )

protectedpure virtual

Handler for command FORCE_GROUP

Force telemetering a group on a section, even if disabled

Parameters

opCode	The opcode
cmdSeq	The command sequence number
section	Section grouping
tlmGroup	Group Identifier
enable	Section enabled or disabled

FORCE_GROUP_cmdHandlerBase()

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

protected

Base-class handler function for command FORCE_GROUP

Force telemetering a group on a section, even if disabled

Parameters

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

Definition at line 1998 of file TlmPacketizerComponentAc.cpp.

FORCE_GROUP_preMsgHook()

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

protectedvirtual

Pre-message hook for command FORCE_GROUP.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 2168 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 500 of file TlmPacketizerComponentAc.cpp.

get_configureSectionGroupRate_InputPort()

Svc::InputConfigureGroupRatePort * Svc::TlmPacketizerComponentBase::get_configureSectionGroupRate_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

configureSectionGroupRate[portNum]

Parameters

portNum

The port number

Definition at line 552 of file TlmPacketizerComponentAc.cpp.

get_controlIn_InputPort()

Svc::InputEnableSectionPort * Svc::TlmPacketizerComponentBase::get_controlIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

controlIn[portNum]

Parameters

portNum

The port number

Definition at line 563 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 574 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 519 of file TlmPacketizerComponentAc.cpp.

get_TlmGet_InputPort()

Fw::InputTlmGetPort * Svc::TlmPacketizerComponentBase::get_TlmGet_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

TlmGet[portNum]

Parameters

portNum

The port number

Definition at line 530 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 541 of file TlmPacketizerComponentAc.cpp.

getNum_cmdIn_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdIn_InputPorts ( )

inlinestaticprotected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 436 of file TlmPacketizerComponentAc.hpp.

getNum_cmdRegOut_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdRegOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 497 of file TlmPacketizerComponentAc.hpp.

getNum_cmdResponseOut_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_cmdResponseOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 504 of file TlmPacketizerComponentAc.hpp.

getNum_configureSectionGroupRate_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_configureSectionGroupRate_InputPorts ( )

inlinestaticprotected

Get the number of configureSectionGroupRate input ports

Returns

The number of configureSectionGroupRate input ports

Definition at line 470 of file TlmPacketizerComponentAc.hpp.

getNum_controlIn_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_controlIn_InputPorts ( )

inlinestaticprotected

Get the number of controlIn input ports

Returns

The number of controlIn input ports

Definition at line 477 of file TlmPacketizerComponentAc.hpp.

getNum_eventOut_OutputPorts()

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

inlinestaticprotected

Get the number of eventOut output ports

Returns

The number of eventOut output ports

Definition at line 511 of file TlmPacketizerComponentAc.hpp.

getNum_paramGetOut_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_paramGetOut_OutputPorts ( )

inlinestaticprotected

Get the number of paramGetOut output ports

Returns

The number of paramGetOut output ports

Definition at line 518 of file TlmPacketizerComponentAc.hpp.

getNum_paramSetOut_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_paramSetOut_OutputPorts ( )

inlinestaticprotected

Get the number of paramSetOut output ports

Returns

The number of paramSetOut output ports

Definition at line 525 of file TlmPacketizerComponentAc.hpp.

getNum_pingIn_InputPorts()

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

inlinestaticprotected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 484 of file TlmPacketizerComponentAc.hpp.

getNum_pingOut_OutputPorts()

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

inlinestaticprotected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 570 of file TlmPacketizerComponentAc.hpp.

getNum_PktSend_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_PktSend_OutputPorts ( )

inlinestaticprotected

Get the number of PktSend output ports

Returns

The number of PktSend output ports

Definition at line 563 of file TlmPacketizerComponentAc.hpp.

getNum_Run_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_Run_InputPorts ( )

inlinestaticprotected

Get the number of Run input ports

Returns

The number of Run input ports

Definition at line 449 of file TlmPacketizerComponentAc.hpp.

getNum_timeGetOut_OutputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_timeGetOut_OutputPorts ( )

inlinestaticprotected

Get the number of timeGetOut output ports

Returns

The number of timeGetOut output ports

Definition at line 543 of file TlmPacketizerComponentAc.hpp.

getNum_TlmGet_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_TlmGet_InputPorts ( )

inlinestaticprotected

Get the number of TlmGet input ports

Returns

The number of TlmGet input ports

Definition at line 456 of file TlmPacketizerComponentAc.hpp.

getNum_tlmOut_OutputPorts()

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

inlinestaticprotected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 550 of file TlmPacketizerComponentAc.hpp.

getNum_TlmRecv_InputPorts()

static constexpr FwIndexType Svc::TlmPacketizerComponentBase::getNum_TlmRecv_InputPorts ( )

inlinestaticprotected

Get the number of TlmRecv input ports

Returns

The number of TlmRecv input ports

Definition at line 463 of file TlmPacketizerComponentAc.hpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 2895 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 82 of file TlmPacketizerComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

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

protected

Check whether port cmdRegOut is connected

Returns

Whether port cmdRegOut is connected

Parameters

portNum

The port number

Definition at line 1086 of file TlmPacketizerComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

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

protected

Check whether port cmdResponseOut is connected

Returns

Whether port cmdResponseOut is connected

Parameters

portNum

The port number

Definition at line 1097 of file TlmPacketizerComponentAc.cpp.

isConnected_eventOut_OutputPort()

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

isConnected_paramGetOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_paramGetOut_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port paramGetOut is connected

Returns

Whether port paramGetOut is connected

Parameters

portNum

The port number

Definition at line 1119 of file TlmPacketizerComponentAc.cpp.

isConnected_paramSetOut_OutputPort()

bool Svc::TlmPacketizerComponentBase::isConnected_paramSetOut_OutputPort ( FwIndexType  portNum ) const

protected

Check whether port paramSetOut is connected

Returns

Whether port paramSetOut is connected

Parameters

portNum

The port number

Definition at line 1130 of file TlmPacketizerComponentAc.cpp.

isConnected_pingOut_OutputPort()

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

isConnected_PktSend_OutputPort()

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

protected

Check whether port PktSend is connected

Returns

Whether port PktSend is connected

Parameters

portNum

The port number

Definition at line 1186 of file TlmPacketizerComponentAc.cpp.

isConnected_timeGetOut_OutputPort()

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

protected

Check whether port timeGetOut is connected

Returns

Whether port timeGetOut is connected

Parameters

portNum

The port number

Definition at line 1156 of file TlmPacketizerComponentAc.cpp.

isConnected_tlmOut_OutputPort()

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

loadParameters()

void Svc::TlmPacketizerComponentBase::loadParameters

(

)

Load the parameters from a parameter source.

Connect the parameter first

Definition at line 957 of file TlmPacketizerComponentAc.cpp.

log_ACTIVITY_HI_LevelSet()

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

protected

Log event LevelSet

Telemetry send level set

Parameters

id

The level

Definition at line 2276 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 2460 of file TlmPacketizerComponentAc.cpp.

log_WARNING_LO_MaxLevelExceed()

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

protected

Log event MaxLevelExceed

Telemetry send level set

Parameters

level	The level
max	The max packet level

Definition at line 2358 of file TlmPacketizerComponentAc.cpp.

log_WARNING_LO_NoChan()

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

protected

Log event NoChan

Telemetry channel is not part of a telemetry packet.

Parameters

Id	The telemetry ID

Definition at line 2194 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 2542 of file TlmPacketizerComponentAc.cpp.

log_WARNING_LO_SectionUnconfigurable()

void Svc::TlmPacketizerComponentBase::log_WARNING_LO_SectionUnconfigurable ( Svc::TelemetrySection  section, Fw::Enabled  enable  ) const

protected

Log event SectionUnconfigurable.

Parameters

section	The Section
enable	Attempted Configuration

Definition at line 2624 of file TlmPacketizerComponentAc.cpp.

parametersLoaded()

void Svc::TlmPacketizerComponentBase::parametersLoaded ( )

protectedvirtual

Called whenever parameters are loaded.

This function does nothing by default. You may override it.

Definition at line 2820 of file TlmPacketizerComponentAc.cpp.

parameterUpdated()

void Svc::TlmPacketizerComponentBase::parameterUpdated ( FwPrmIdType  id )

protectedvirtual

Called whenever a parameter is updated.

This function does nothing by default. You may override it.

Parameters

id	The parameter ID

Definition at line 2814 of file TlmPacketizerComponentAc.cpp.

paramGet_SECTION_CONFIGS()

Svc::TlmPacketizer_SectionConfigs Svc::TlmPacketizerComponentBase::paramGet_SECTION_CONFIGS ( Fw::ParamValid &  valid )

protected

Get parameter SECTION_CONFIGS

Returns

The parameter value

Parameter to control section configuration

Parameters

valid

Whether the parameter is valid

Definition at line 2855 of file TlmPacketizerComponentAc.cpp.

paramGet_SECTION_ENABLED()

Svc::TlmPacketizer_SectionEnabled Svc::TlmPacketizerComponentBase::paramGet_SECTION_ENABLED ( Fw::ParamValid &  valid )

protected

Get parameter SECTION_ENABLED

Returns

The parameter value

Parameter to control section enable flags

Parameters

valid

Whether the parameter is valid

Definition at line 2830 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 1589 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 1682 of file TlmPacketizerComponentAc.cpp.

pingOut_out()

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

PktSend_out()

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

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 1697 of file TlmPacketizerComponentAc.cpp.

regCommands()

void Svc::TlmPacketizerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 897 of file TlmPacketizerComponentAc.cpp.

registerExternalParameters()

void Svc::TlmPacketizerComponentBase::registerExternalParameters ( Fw::ParamExternalDelegate *  paramExternalDelegatePtr )

protected

Initialize the external parameter delegate.

Parameters

paramExternalDelegatePtr

The delegate for externally managed parameters

Definition at line 2884 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 1335 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 1650 of file TlmPacketizerComponentAc.cpp.

SEND_PKT_cmdHandler()

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

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
section	Section to emit packet

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 1821 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 2135 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 593 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 607 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 621 of file TlmPacketizerComponentAc.cpp.

SET_LEVEL_cmdHandler()

virtual void Svc::TlmPacketizerComponentBase::SET_LEVEL_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, FwChanIdType  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 1762 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 2124 of file TlmPacketizerComponentAc.cpp.

set_paramGetOut_OutputPort()

void Svc::TlmPacketizerComponentBase::set_paramGetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputPrmGetPort *	port
	)

Connect port to paramGetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 635 of file TlmPacketizerComponentAc.cpp.

set_paramSetOut_OutputPort()

void Svc::TlmPacketizerComponentBase::set_paramSetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputPrmSetPort *	port
	)

Connect port to paramSetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 649 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 731 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 717 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 681 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 695 of file TlmPacketizerComponentAc.cpp.

TlmGet_handler()

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

protectedpure virtual

Handler for input port TlmGet.

Parameters

portNum	The port number
id	Telemetry Channel ID
timeTag	Time Tag
val	Buffer containing serialized telemetry value. Size set to 0 if channel not found, or if no value has been received for this channel yet.

TlmGet_handlerBase()

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

protected

Handler base-class function for input port TlmGet.

Parameters

portNum	The port number
id	Telemetry Channel ID
timeTag	Time Tag
val	Buffer containing serialized telemetry value. Size set to 0 if channel not found, or if no value has been received for this channel yet.

Definition at line 1388 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 1415 of file TlmPacketizerComponentAc.cpp.

tlmWrite()

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

tlmWrite_GroupConfigs()

void Svc::TlmPacketizerComponentBase::tlmWrite_GroupConfigs ( const Svc::TlmPacketizer_SectionConfigs &  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel GroupConfigs

Telemetry send level

Parameters

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

Definition at line 2766 of file TlmPacketizerComponentAc.cpp.

tlmWrite_SectionEnabled()

void Svc::TlmPacketizerComponentBase::tlmWrite_SectionEnabled ( const Svc::TlmPacketizer_SectionEnabled &  arg, Fw::Time  _tlmTime = Fw::Time()  ) const

protected

Write telemetry channel SectionEnabled.

Parameters

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

Definition at line 2788 of file TlmPacketizerComponentAc.cpp.

Friends And Related Function Documentation

TlmPacketizerTester

friend class TlmPacketizerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 71 of file TlmPacketizerComponentAc.hpp.

TlmPacketizerTesterBase

friend class TlmPacketizerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 69 of file TlmPacketizerComponentAc.hpp.

---

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

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