F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::InputPingPort Class Reference

#include <Svc/Ping/PingPortAc.hpp>

Inheritance diagram for Svc::InputPingPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

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

Public Member Functions

 InputPingPort ()
 Constructor.
 
void init ()
 Initialization function.
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component.
 
void invoke (U32 key)
 Invoke a port interface.
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (NATIVE_INT_TYPE portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected () const
 

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.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 
- 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 Ping port Port for pinging active components

Definition at line 24 of file PingPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Svc::InputPingPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, U32 key)

The port callback function type.

Definition at line 47 of file PingPortAc.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 PingPortAc.hpp.

Constructor & Destructor Documentation

◆ InputPingPort()

Svc::InputPingPort::InputPingPort ( )

Constructor.

Definition at line 47 of file PingPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Svc::InputPingPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file PingPortAc.cpp.

◆ init()

void Svc::InputPingPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file PingPortAc.cpp.

◆ invoke()

void Svc::InputPingPort::invoke ( U32  key)

Invoke a port interface.

Parameters
keyValue to return to pinger

Definition at line 75 of file PingPortAc.cpp.


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