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

#include <Svc/TlmChan/TlmChanComponentAc.hpp>

Inheritance diagram for Svc::TlmChanComponentBase:

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

Svc::InputSchedPort *	get_Run_InputPort (FwIndexType portNum)

Fw::InputTlmGetPort *	get_TlmGet_InputPort (FwIndexType portNum)

Fw::InputTlmPort *	get_TlmRecv_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType 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].

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_RUN_INPUT_PORTS = 1 , NUM_TLMGET_INPUT_PORTS = 1 , NUM_TLMRECV_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

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

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
	Tracks the lifecycle of the component. More...

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

virtual	~TlmChanComponentBase ()
	Destroy TlmChanComponentBase object.

FwIndexType	getNum_Run_InputPorts () const

FwIndexType	getNum_TlmGet_InputPorts () const

FwIndexType	getNum_TlmRecv_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_PktSend_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

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	TlmGet_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0
	Handler for input port TlmGet.

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	TlmGet_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
	Handler base-class function for input port TlmGet.

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.

virtual void	lock ()
	Lock the guarded mutex.

virtual void	unLock ()
	Unlock the guarded mutex.

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	TlmChanComponentBaseFriend
	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 TlmChan component.

A component for storing telemetry

Definition at line 27 of file TlmChanComponentAc.hpp.

Member Enumeration Documentation

◆ 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_PINGIN_INPUT_PORTS

Definition at line 45 of file TlmChanComponentAc.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 53 of file TlmChanComponentAc.hpp.

Constructor & Destructor Documentation

◆ TlmChanComponentBase()

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

protected

Construct TlmChanComponentBase object.

Parameters

compName The component name

Definition at line 344 of file TlmChanComponentAc.cpp.

◆ ~TlmChanComponentBase()

Svc::TlmChanComponentBase::~TlmChanComponentBase ( )

protectedvirtual

Destroy TlmChanComponentBase object.

Definition at line 351 of file TlmChanComponentAc.cpp.

Member Function Documentation

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 261 of file TlmChanComponentAc.cpp.

◆ get_Run_InputPort()

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

Get typed input port at index

Returns: Run[portNum]

Parameters

portNum The port number

Definition at line 228 of file TlmChanComponentAc.cpp.

◆ get_TlmGet_InputPort()

Fw::InputTlmGetPort * Svc::TlmChanComponentBase::get_TlmGet_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: TlmGet[portNum]

Parameters

portNum The port number

Definition at line 239 of file TlmChanComponentAc.cpp.

◆ get_TlmRecv_InputPort()

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

Get typed input port at index

Returns: TlmRecv[portNum]

Parameters

portNum The port number

Definition at line 250 of file TlmChanComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 379 of file TlmChanComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 395 of file TlmChanComponentAc.cpp.

◆ getNum_PktSend_OutputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_PktSend_OutputPorts ( ) const

protected

Get the number of PktSend output ports

Returns: The number of PktSend output ports

Definition at line 389 of file TlmChanComponentAc.cpp.

◆ getNum_Run_InputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_Run_InputPorts ( ) const

protected

Get the number of Run input ports

Returns: The number of Run input ports

Definition at line 361 of file TlmChanComponentAc.cpp.

◆ getNum_TlmGet_InputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_TlmGet_InputPorts ( ) const

protected

Get the number of TlmGet input ports

Returns: The number of TlmGet input ports

Definition at line 367 of file TlmChanComponentAc.cpp.

◆ getNum_TlmRecv_InputPorts()

FwIndexType Svc::TlmChanComponentBase::getNum_TlmRecv_InputPorts ( ) const

protected

Get the number of TlmRecv input ports

Returns: The number of TlmRecv input ports

Definition at line 373 of file TlmChanComponentAc.cpp.

◆ init()

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

Initialize TlmChanComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 70 of file TlmChanComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::TlmChanComponentBase::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 416 of file TlmChanComponentAc.cpp.

◆ isConnected_PktSend_OutputPort()

bool Svc::TlmChanComponentBase::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 405 of file TlmChanComponentAc.cpp.

◆ lock()

void Svc::TlmChanComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 666 of file TlmChanComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::TlmChanComponentBase::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::TlmChanComponentBase::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 544 of file TlmChanComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::TlmChanComponentBase::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 614 of file TlmChanComponentAc.cpp.

◆ pingOut_out()

void Svc::TlmChanComponentBase::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 644 of file TlmChanComponentAc.cpp.

◆ PktSend_out()

void Svc::TlmChanComponentBase::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 627 of file TlmChanComponentAc.cpp.

◆ Run_handler()

virtual void Svc::TlmChanComponentBase::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::TlmChanComponentBase::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 433 of file TlmChanComponentAc.cpp.

◆ Run_preMsgHook()

void Svc::TlmChanComponentBase::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 605 of file TlmChanComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::TlmChanComponentBase::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 290 of file TlmChanComponentAc.cpp.

◆ set_PktSend_OutputPort()

void Svc::TlmChanComponentBase::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 276 of file TlmChanComponentAc.cpp.

◆ TlmGet_handler()

virtual void Svc::TlmChanComponentBase::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

◆ TlmGet_handlerBase()

void Svc::TlmChanComponentBase::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

Definition at line 486 of file TlmChanComponentAc.cpp.

◆ TlmRecv_handler()

virtual void Svc::TlmChanComponentBase::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::TlmChanComponentBase::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 515 of file TlmChanComponentAc.cpp.

◆ unLock()

void Svc::TlmChanComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 672 of file TlmChanComponentAc.cpp.

Friends And Related Symbol Documentation

◆ TlmChanComponentBaseFriend

friend class TlmChanComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 36 of file TlmChanComponentAc.hpp.

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

Svc/TlmChan/TlmChanComponentAc.hpp
Svc/TlmChan/TlmChanComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ TlmChanComponentBase()

◆ ~TlmChanComponentBase()

Member Function Documentation

◆ get_pingIn_InputPort()

◆ get_Run_InputPort()

◆ get_TlmGet_InputPort()

◆ get_TlmRecv_InputPort()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_PktSend_OutputPorts()

◆ getNum_Run_InputPorts()

◆ getNum_TlmGet_InputPorts()

◆ getNum_TlmRecv_InputPorts()

◆ init()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_PktSend_OutputPort()

◆ lock()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ PktSend_out()

◆ Run_handler()

◆ Run_handlerBase()

◆ Run_preMsgHook()

◆ set_pingOut_OutputPort()

◆ set_PktSend_OutputPort()

◆ TlmGet_handler()

◆ TlmGet_handlerBase()

◆ TlmRecv_handler()

◆ TlmRecv_handlerBase()

◆ unLock()

Friends And Related Symbol Documentation

◆ TlmChanComponentBaseFriend