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

#include <Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapter.hpp>

Inheritance diagram for Drv::ByteStreamBufferAdapter:
Drv::ByteStreamBufferAdapterComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 ByteStreamBufferAdapter (const char *const compName)
 Construct ByteStreamBufferAdapter object. More...
 
 ~ByteStreamBufferAdapter ()
 Destroy ByteStreamBufferAdapter object. More...
 
- Public Member Functions inherited from Drv::ByteStreamBufferAdapterComponentBase
void init (FwEnumStoreType instance=0)
 Initialize ByteStreamBufferAdapterComponentBase object. More...
 
Fw::InputBufferSendPortget_bufferIn_InputPort (FwIndexType portNum)
 
Fw::InputBufferSendPortget_bufferOutReturn_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamReadyPortget_byteStreamDriverReady_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamDataPortget_fromByteStreamDriver_InputPort (FwIndexType portNum)
 
void set_bufferInReturn_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferInReturn[portNum]. More...
 
void set_bufferOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferOut[portNum]. More...
 
void set_fromByteStreamDriverReturn_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to fromByteStreamDriverReturn[portNum]. More...
 
void set_toByteStreamDriver_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port)
 Connect port to toByteStreamDriver[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const FwIdType)
 Set the ID base. More...
 
FwIdType getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Drv::ByteStreamBufferAdapterComponentBase
enum  { NUM_BUFFERIN_INPUT_PORTS = 1, NUM_BUFFEROUTRETURN_INPUT_PORTS = 1, NUM_BYTESTREAMDRIVERREADY_INPUT_PORTS = 1, NUM_FROMBYTESTREAMDRIVER_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_BUFFERINRETURN_OUTPUT_PORTS = 1, NUM_BUFFEROUT_OUTPUT_PORTS = 1, NUM_FROMBYTESTREAMDRIVERRETURN_OUTPUT_PORTS = 1, NUM_TOBYTESTREAMDRIVER_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
- Protected Member Functions inherited from Drv::ByteStreamBufferAdapterComponentBase
 ByteStreamBufferAdapterComponentBase (const char *compName="")
 Construct ByteStreamBufferAdapterComponentBase object. More...
 
virtual ~ByteStreamBufferAdapterComponentBase ()
 Destroy ByteStreamBufferAdapterComponentBase object. More...
 
bool isConnected_bufferInReturn_OutputPort (FwIndexType portNum)
 
bool isConnected_bufferOut_OutputPort (FwIndexType portNum)
 
bool isConnected_fromByteStreamDriverReturn_OutputPort (FwIndexType portNum)
 
bool isConnected_toByteStreamDriver_OutputPort (FwIndexType portNum)
 
void bufferIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port bufferIn. More...
 
void bufferOutReturn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port bufferOutReturn. More...
 
void byteStreamDriverReady_handlerBase (FwIndexType portNum)
 Handler base-class function for input port byteStreamDriverReady. More...
 
void fromByteStreamDriver_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
 Handler base-class function for input port fromByteStreamDriver. More...
 
void bufferInReturn_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferInReturn. More...
 
void bufferOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferOut. More...
 
void fromByteStreamDriverReturn_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port fromByteStreamDriverReturn. More...
 
Drv::ByteStreamStatus toByteStreamDriver_out (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Invoke output port toByteStreamDriver. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (FwEnumStoreType instance)
 Initialization function. More...
 
FwEnumStoreType getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 
- Static Protected Member Functions inherited from Drv::ByteStreamBufferAdapterComponentBase
static constexpr FwIndexType getNum_bufferIn_InputPorts ()
 
static constexpr FwIndexType getNum_bufferOutReturn_InputPorts ()
 
static constexpr FwIndexType getNum_byteStreamDriverReady_InputPorts ()
 
static constexpr FwIndexType getNum_fromByteStreamDriver_InputPorts ()
 
static constexpr FwIndexType getNum_bufferInReturn_OutputPorts ()
 
static constexpr FwIndexType getNum_bufferOut_OutputPorts ()
 
static constexpr FwIndexType getNum_fromByteStreamDriverReturn_OutputPorts ()
 
static constexpr FwIndexType getNum_toByteStreamDriver_OutputPorts ()
 

Detailed Description

Definition at line 14 of file ByteStreamBufferAdapter.hpp.

Constructor & Destructor Documentation

◆ ByteStreamBufferAdapter()

Drv::ByteStreamBufferAdapter::ByteStreamBufferAdapter ( const char *const  compName)

Construct ByteStreamBufferAdapter object.

Parameters
compNameThe component name

Definition at line 15 of file ByteStreamBufferAdapter.cpp.

◆ ~ByteStreamBufferAdapter()

Drv::ByteStreamBufferAdapter::~ByteStreamBufferAdapter ( )

Destroy ByteStreamBufferAdapter object.

Definition at line 18 of file ByteStreamBufferAdapter.cpp.


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