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

#include <Fw/Tlm/TlmPortAc.hpp>

Inheritance diagram for Fw::InputTlmPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 The port callback function type. More...
 

Public Member Functions

 InputTlmPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (NATIVE_INT_TYPE portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected ()
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
- Protected Member Functions inherited from Fw::PortBase
 PortBase ()
 
virtual ~PortBase ()
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 
- Protected Attributes inherited from Fw::InputPortBase
PassiveComponentBasem_comp
 
NATIVE_INT_TYPE m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input Tlm port Port for sending telemetry

Definition at line 26 of file TlmPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputTlmPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)

The port callback function type.

Definition at line 51 of file TlmPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 36 of file TlmPortAc.hpp.

Constructor & Destructor Documentation

◆ InputTlmPort()

Fw::InputTlmPort::InputTlmPort ( )

Constructor.

Definition at line 47 of file TlmPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Fw::InputTlmPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file TlmPortAc.cpp.

◆ init()

void Fw::InputTlmPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file TlmPortAc.cpp.

◆ invoke()

void Fw::InputTlmPort::invoke ( FwChanIdType  id,
Fw::Time timeTag,
Fw::TlmBuffer val 
)

Invoke a port interface.

Parameters
idTelemetry Channel ID
timeTagTime Tag
valBuffer containing serialized telemetry value

Definition at line 75 of file TlmPortAc.cpp.


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