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

#include <Fw/Ports/Signal/SignalPortAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE = 0 }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum)
 The port callback function type. More...
 

Public Member Functions

 InputSignalPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke ()
 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 Signal port Port to signal some condition

Definition at line 24 of file SignalPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputSignalPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum)

The port callback function type.

Definition at line 46 of file SignalPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 34 of file SignalPortAc.hpp.

Constructor & Destructor Documentation

◆ InputSignalPort()

Fw::InputSignalPort::InputSignalPort ( )

Constructor.

Definition at line 44 of file SignalPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 58 of file SignalPortAc.cpp.

◆ init()

void Fw::InputSignalPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::PortBase.

Definition at line 52 of file SignalPortAc.cpp.

◆ invoke()

void Fw::InputSignalPort::invoke ( )

Invoke a port interface.

Definition at line 72 of file SignalPortAc.cpp.


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