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

Input ByteStreamPoll port. More...

#include <Drv/ByteStreamDriverModel/ByteStreamPollPortAc.hpp>

Inheritance diagram for Drv::InputByteStreamPollPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE }
 
typedef Drv::PollStatus(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::Buffer &pollBuffer)
 The port callback function type. More...
 

Public Member Functions

 InputByteStreamPollPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
Drv::PollStatus invoke (Fw::Buffer &pollBuffer)
 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 ByteStreamPoll port.

Definition at line 24 of file ByteStreamPollPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Drv::PollStatus(* Drv::InputByteStreamPollPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::Buffer &pollBuffer)

The port callback function type.

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

Constructor & Destructor Documentation

◆ InputByteStreamPollPort()

Drv::InputByteStreamPollPort::InputByteStreamPollPort ( )

Constructor.

Definition at line 17 of file ByteStreamPollPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Drv::InputByteStreamPollPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 31 of file ByteStreamPollPortAc.cpp.

◆ init()

void Drv::InputByteStreamPollPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 25 of file ByteStreamPollPortAc.cpp.

◆ invoke()

Drv::PollStatus Drv::InputByteStreamPollPort::invoke ( Fw::Buffer pollBuffer)

Invoke a port interface.

Definition at line 45 of file ByteStreamPollPortAc.cpp.


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