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

Input SpiReadWrite port. More...

#include <Drv/SpiDriverPorts/SpiReadWritePortAc.hpp>

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

Public Types

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

Public Member Functions

 InputSpiReadWritePort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)
 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 SpiReadWrite port.

Definition at line 24 of file SpiReadWritePortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Drv::InputSpiReadWritePort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)

The port callback function type.

Definition at line 48 of file SpiReadWritePortAc.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 SpiReadWritePortAc.hpp.

Constructor & Destructor Documentation

◆ InputSpiReadWritePort()

Drv::InputSpiReadWritePort::InputSpiReadWritePort ( )

Constructor.

Definition at line 47 of file SpiReadWritePortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file SpiReadWritePortAc.cpp.

◆ init()

void Drv::InputSpiReadWritePort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file SpiReadWritePortAc.cpp.

◆ invoke()

void Drv::InputSpiReadWritePort::invoke ( Fw::Buffer writeBuffer,
Fw::Buffer readBuffer 
)

Invoke a port interface.

Definition at line 75 of file SpiReadWritePortAc.cpp.


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