Svc::TlmChan Class Reference

#include <Svc/TlmChan/TlmChan.hpp>

Inheritance diagram for Svc::TlmChan:

Public Member Functions
	TlmChan (const char *compName)
virtual	~TlmChan ()
Public Member Functions inherited from Svc::TlmChanComponentBase
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 Member Functions
virtual NATIVE_UINT_TYPE	doHash (FwChanIdType id)
Protected Member Functions inherited from Svc::TlmChanComponentBase
	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)
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.

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }
Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }
Protected Types inherited from Svc::TlmChanComponentBase
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 Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Definition at line 22 of file TlmChan.hpp.

Constructor & Destructor Documentation

TlmChan()

Svc::TlmChan::TlmChan

(

const char *

compName

)

Definition at line 19 of file TlmChan.cpp.

~TlmChan()

Svc::TlmChan::~TlmChan ( )

virtual

Definition at line 43 of file TlmChan.cpp.

Member Function Documentation

doHash()

NATIVE_UINT_TYPE Svc::TlmChan::doHash ( FwChanIdType  id )

protectedvirtual

Definition at line 45 of file TlmChan.cpp.

---

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

• Svc/TlmChan/TlmChan.hpp
• Svc/TlmChan/TlmChan.cpp