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

#include <Svc/ComStub/ComStub.hpp>

Inheritance diagram for Svc::ComStub:
Svc::ComStubComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 ComStub (const char *const compName)
 
 ~ComStub () override
 
- Public Member Functions inherited from Svc::ComStubComponentBase
void init (FwEnumStoreType instance=0)
 Initialize ComStubComponentBase object. More...
 
Drv::InputByteStreamSendPortget_comDataIn_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamReadyPortget_drvConnected_InputPort (FwIndexType portNum)
 
Drv::InputByteStreamRecvPortget_drvDataIn_InputPort (FwIndexType portNum)
 
void set_comDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *port)
 Connect port to comDataOut[portNum]. More...
 
void set_comStatus_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
 Connect port to comStatus[portNum]. More...
 
void set_drvDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port)
 Connect port to drvDataOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Public Attributes

const NATIVE_UINT_TYPE RETRY_LIMIT = 10
 

Additional Inherited Members

- Protected Types inherited from Svc::ComStubComponentBase
enum  { NUM_COMDATAIN_INPUT_PORTS = 1 , NUM_DRVCONNECTED_INPUT_PORTS = 1 , NUM_DRVDATAIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_COMDATAOUT_OUTPUT_PORTS = 1 , NUM_COMSTATUS_OUTPUT_PORTS = 1 , NUM_DRVDATAOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
- Protected Member Functions inherited from Svc::ComStubComponentBase
 ComStubComponentBase (const char *compName="")
 Construct ComStubComponentBase object. More...
 
virtual ~ComStubComponentBase ()
 Destroy ComStubComponentBase object. More...
 
FwIndexType getNum_comDataIn_InputPorts () const
 
FwIndexType getNum_drvConnected_InputPorts () const
 
FwIndexType getNum_drvDataIn_InputPorts () const
 
FwIndexType getNum_comDataOut_OutputPorts () const
 
FwIndexType getNum_comStatus_OutputPorts () const
 
FwIndexType getNum_drvDataOut_OutputPorts () const
 
bool isConnected_comDataOut_OutputPort (FwIndexType portNum)
 
bool isConnected_comStatus_OutputPort (FwIndexType portNum)
 
bool isConnected_drvDataOut_OutputPort (FwIndexType portNum)
 
Drv::SendStatus comDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Handler base-class function for input port comDataIn. More...
 
void drvConnected_handlerBase (FwIndexType portNum)
 Handler base-class function for input port drvConnected. More...
 
void drvDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
 Handler base-class function for input port drvDataIn. More...
 
void comDataOut_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
 Invoke output port comDataOut. More...
 
void comStatus_out (FwIndexType portNum, Fw::Success &condition)
 Invoke output port comStatus. More...
 
Drv::SendStatus drvDataOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer)
 Invoke output port drvDataOut. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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...
 

Detailed Description

Definition at line 14 of file ComStub.hpp.

Constructor & Destructor Documentation

◆ ComStub()

Svc::ComStub::ComStub ( const char *const  compName)

Construct object ComStub

Parameters
compNameThe component name

Definition at line 17 of file ComStub.cpp.

◆ ~ComStub()

Svc::ComStub::~ComStub ( )
override

Destroy object ComStub

Definition at line 19 of file ComStub.cpp.

Member Data Documentation

◆ RETRY_LIMIT

const NATIVE_UINT_TYPE Svc::ComStub::RETRY_LIMIT = 10

Definition at line 16 of file ComStub.hpp.


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