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

#include <Svc/PolyIf/PolyPortAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)
 The port callback function type. More...
 

Public Member Functions

 InputPolyPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &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 Poly port Port for setting and getting PolyType values

Definition at line 28 of file PolyPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Svc::InputPolyPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)

The port callback function type.

Definition at line 54 of file PolyPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 38 of file PolyPortAc.hpp.

Constructor & Destructor Documentation

◆ InputPolyPort()

Svc::InputPolyPort::InputPolyPort ( )

Constructor.

Definition at line 47 of file PolyPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file PolyPortAc.cpp.

◆ init()

void Svc::InputPolyPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file PolyPortAc.cpp.

◆ invoke()

void Svc::InputPolyPort::invoke ( const Svc::PolyDbCfg::PolyDbEntry entry,
Svc::MeasurementStatus status,
Fw::Time time,
Fw::PolyType val 
)

Invoke a port interface.

Parameters
entryThe entry to access
statusThe command response argument
timeThe time of the measurement
valThe value to be passed

Definition at line 75 of file PolyPortAc.cpp.


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