F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::TlmChan Class Reference

#include <Svc/TlmChan/TlmChan.hpp>

Inheritance diagram for Svc::TlmChan:
Svc::TlmChanComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

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. More...
 
Svc::InputSchedPortget_Run_InputPort (FwIndexType portNum)
 
Fw::InputTlmGetPortget_TlmGet_InputPort (FwIndexType portNum)
 
Fw::InputTlmPortget_TlmRecv_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
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...
 
- 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 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::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
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. More...
 
virtual ~TlmChanComponentBase ()
 Destroy TlmChanComponentBase object. More...
 
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. More...
 
void 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 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 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)
 Invoke output port PktSend. More...
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut. More...
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor. More...
 
virtual ~ActiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE 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 (NATIVE_INT_TYPE instance)
 initialization function More...
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
NATIVE_INT_TYPE 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 (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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...
 

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 More...
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component More...
 

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: