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

#include <Fw/Com/ComPortAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 The port callback function type. More...
 

Public Member Functions

 InputComPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (Fw::ComBuffer &data, U32 context)
 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 Com port Port for passing communication packet buffers

Definition at line 25 of file ComPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputComPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::ComBuffer &data, U32 context)

The port callback function type.

Definition at line 49 of file ComPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 35 of file ComPortAc.hpp.

Constructor & Destructor Documentation

◆ InputComPort()

Fw::InputComPort::InputComPort ( )

Constructor.

Definition at line 47 of file ComPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file ComPortAc.cpp.

◆ init()

void Fw::InputComPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file ComPortAc.cpp.

◆ invoke()

void Fw::InputComPort::invoke ( Fw::ComBuffer data,
U32  context 
)

Invoke a port interface.

Parameters
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 75 of file ComPortAc.cpp.


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