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

#include <Fw/Tlm/TlmGetPortAc.hpp>

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

Public Types

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

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
void init () override
 
- 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
 
FwIndexType m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input TlmGet port Port for getting telemetry

Definition at line 27 of file TlmGetPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

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

The port callback function type.

Definition at line 52 of file TlmGetPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 37 of file TlmGetPortAc.hpp.

Constructor & Destructor Documentation

◆ InputTlmGetPort()

Fw::InputTlmGetPort::InputTlmGetPort ( )

Constructor.

Definition at line 18 of file TlmGetPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 32 of file TlmGetPortAc.cpp.

◆ init()

void Fw::InputTlmGetPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::PortBase.

Definition at line 26 of file TlmGetPortAc.cpp.

◆ invoke()

Fw::TlmValid Fw::InputTlmGetPort::invoke ( FwChanIdType  id,
Fw::Time timeTag,
Fw::TlmBuffer val 
)

Invoke a port interface.

Parameters
idTelemetry Channel ID
timeTagTime Tag
valBuffer 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 46 of file TlmGetPortAc.cpp.


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