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

#include <Fw/Prm/PrmGetPortAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE }
 
typedef Fw::ParamValid(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
 The port callback function type. More...
 

Public Member Functions

 InputPrmGetPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
Fw::ParamValid invoke (FwPrmIdType id, Fw::ParamBuffer &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 PrmGet port Port for getting a parameter

Definition at line 26 of file PrmGetPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Fw::ParamValid(* Fw::InputPrmGetPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)

The port callback function type.

Definition at line 50 of file PrmGetPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 36 of file PrmGetPortAc.hpp.

Constructor & Destructor Documentation

◆ InputPrmGetPort()

Fw::InputPrmGetPort::InputPrmGetPort ( )

Constructor.

Definition at line 18 of file PrmGetPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 32 of file PrmGetPortAc.cpp.

◆ init()

void Fw::InputPrmGetPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::PortBase.

Definition at line 26 of file PrmGetPortAc.cpp.

◆ invoke()

Fw::ParamValid Fw::InputPrmGetPort::invoke ( FwPrmIdType  id,
Fw::ParamBuffer val 
)

Invoke a port interface.

Parameters
idParameter ID
valBuffer containing serialized parameter value. Unmodified if param not found.

Definition at line 46 of file PrmGetPortAc.cpp.


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