![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for ComStub component. More...
#include <Svc/ComStub/ComStubComponentAc.hpp>
Protected Types | |
| enum | { NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1, NUM_DRVASYNCSENDRETURNIN_INPUT_PORTS = 1, NUM_DRVCONNECTED_INPUT_PORTS = 1, NUM_DRVRECEIVEIN_INPUT_PORTS = 1 } |
| Enumerations for numbers of typed input ports. More... | |
| enum | { NUM_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1, NUM_DRVASYNCSENDOUT_OUTPUT_PORTS = 1, NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS = 1, NUM_DRVSENDOUT_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of typed output ports. More... | |
Protected Member Functions | |
| ComStubComponentBase (const char *compName="") | |
| Construct ComStubComponentBase object. More... | |
| virtual | ~ComStubComponentBase () |
| Destroy ComStubComponentBase object. More... | |
| bool | isConnected_comStatusOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_dataOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_dataReturnOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_drvAsyncSendOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_drvReceiveReturnOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_drvSendOut_OutputPort (FwIndexType portNum) |
| virtual void | dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0 |
| Handler for input port dataIn. More... | |
| virtual void | dataReturnIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0 |
| Handler for input port dataReturnIn. More... | |
| virtual void | drvAsyncSendReturnIn_handler (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)=0 |
| Handler for input port drvAsyncSendReturnIn. More... | |
| virtual void | drvConnected_handler (FwIndexType portNum)=0 |
| Handler for input port drvConnected. More... | |
| virtual void | drvReceiveIn_handler (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)=0 |
| Handler for input port drvReceiveIn. More... | |
| void | dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Handler base-class function for input port dataIn. More... | |
| void | dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Handler base-class function for input port dataReturnIn. More... | |
| void | drvAsyncSendReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status) |
| Handler base-class function for input port drvAsyncSendReturnIn. More... | |
| void | drvConnected_handlerBase (FwIndexType portNum) |
| Handler base-class function for input port drvConnected. More... | |
| void | drvReceiveIn_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status) |
| Handler base-class function for input port drvReceiveIn. More... | |
| void | comStatusOut_out (FwIndexType portNum, Fw::Success &condition) |
| Invoke output port comStatusOut. More... | |
| void | dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Invoke output port dataOut. More... | |
| void | dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) |
| Invoke output port dataReturnOut. More... | |
| void | drvAsyncSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
| Invoke output port drvAsyncSendOut. More... | |
| void | drvReceiveReturnOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
| Invoke output port drvReceiveReturnOut. More... | |
| Drv::ByteStreamStatus | drvSendOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer) |
| Invoke output port drvSendOut. 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 | |
| static constexpr FwIndexType | getNum_dataIn_InputPorts () |
| static constexpr FwIndexType | getNum_dataReturnIn_InputPorts () |
| static constexpr FwIndexType | getNum_drvAsyncSendReturnIn_InputPorts () |
| static constexpr FwIndexType | getNum_drvConnected_InputPorts () |
| static constexpr FwIndexType | getNum_drvReceiveIn_InputPorts () |
| static constexpr FwIndexType | getNum_comStatusOut_OutputPorts () |
| static constexpr FwIndexType | getNum_dataOut_OutputPorts () |
| static constexpr FwIndexType | getNum_dataReturnOut_OutputPorts () |
| static constexpr FwIndexType | getNum_drvAsyncSendOut_OutputPorts () |
| static constexpr FwIndexType | getNum_drvReceiveReturnOut_OutputPorts () |
| static constexpr FwIndexType | getNum_drvSendOut_OutputPorts () |
Friends | |
| class | ComStubTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | ComStubTester |
| Friend class tester implementation to support white-box testing. More... | |
Auto-generated base for ComStub component.
Communication adapter interface implementing communication adapter interface via a Drv.ByteStreamDriver ComStub can use both synchronous and asynchronous byte stream drivers, users should connect the appropriate based on their driver type
Definition at line 29 of file ComStubComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_DATAIN_INPUT_PORTS | |
| NUM_DATARETURNIN_INPUT_PORTS | |
| NUM_DRVASYNCSENDRETURNIN_INPUT_PORTS | |
| NUM_DRVCONNECTED_INPUT_PORTS | |
| NUM_DRVRECEIVEIN_INPUT_PORTS | |
Definition at line 49 of file ComStubComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_COMSTATUSOUT_OUTPUT_PORTS | |
| NUM_DATAOUT_OUTPUT_PORTS | |
| NUM_DATARETURNOUT_OUTPUT_PORTS | |
| NUM_DRVASYNCSENDOUT_OUTPUT_PORTS | |
| NUM_DRVRECEIVERETURNOUT_OUTPUT_PORTS | |
| NUM_DRVSENDOUT_OUTPUT_PORTS | |
Definition at line 58 of file ComStubComponentAc.hpp.
|
protected |
Construct ComStubComponentBase object.
| compName | The component name |
Definition at line 491 of file ComStubComponentAc.cpp.
|
protectedvirtual |
Destroy ComStubComponentBase object.
Definition at line 498 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port comStatusOut.
| portNum | The port number |
| condition | Condition success/failure |
Definition at line 681 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port dataIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port dataIn.
| portNum | The port number |
Definition at line 580 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port dataOut.
| portNum | The port number |
Definition at line 701 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port dataReturnIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port dataReturnIn.
| portNum | The port number |
Definition at line 601 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port dataReturnOut.
| portNum | The port number |
Definition at line 723 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port drvAsyncSendOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 745 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port drvAsyncSendReturnIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port drvAsyncSendReturnIn.
| portNum | The port number |
Definition at line 622 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port drvConnected.
| portNum | The port number |
|
protected |
Handler base-class function for input port drvConnected.
| portNum | The port number |
Definition at line 643 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port drvReceiveIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port drvReceiveIn.
| portNum | The port number |
Definition at line 656 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port drvReceiveReturnOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 765 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port drvSendOut.
| portNum | The port number |
| sendBuffer | Data to send |
Definition at line 785 of file ComStubComponentAc.cpp.
| Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 266 of file ComStubComponentAc.cpp.
| Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataReturnIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 277 of file ComStubComponentAc.cpp.
| Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvAsyncSendReturnIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 288 of file ComStubComponentAc.cpp.
| Drv::InputByteStreamReadyPort * Svc::ComStubComponentBase::get_drvConnected_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 299 of file ComStubComponentAc.cpp.
| Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvReceiveIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 310 of file ComStubComponentAc.cpp.
|
inlinestaticprotected |
Get the number of comStatusOut output ports
Definition at line 265 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataIn input ports
Definition at line 224 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataOut output ports
Definition at line 272 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnIn input ports
Definition at line 231 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of dataReturnOut output ports
Definition at line 279 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvAsyncSendOut output ports
Definition at line 286 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvAsyncSendReturnIn input ports
Definition at line 238 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvConnected input ports
Definition at line 245 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvReceiveIn input ports
Definition at line 252 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvReceiveReturnOut output ports
Definition at line 293 of file ComStubComponentAc.hpp.
|
inlinestaticprotected |
Get the number of drvSendOut output ports
Definition at line 300 of file ComStubComponentAc.hpp.
| void Svc::ComStubComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize ComStubComponentBase object.
| instance | The instance number |
Definition at line 21 of file ComStubComponentAc.cpp.
|
protected |
Check whether port comStatusOut is connected
| portNum | The port number |
Definition at line 508 of file ComStubComponentAc.cpp.
|
protected |
Check whether port dataOut is connected
| portNum | The port number |
Definition at line 519 of file ComStubComponentAc.cpp.
|
protected |
Check whether port dataReturnOut is connected
| portNum | The port number |
Definition at line 530 of file ComStubComponentAc.cpp.
|
protected |
Check whether port drvAsyncSendOut is connected
| portNum | The port number |
Definition at line 541 of file ComStubComponentAc.cpp.
|
protected |
Check whether port drvReceiveReturnOut is connected
| portNum | The port number |
Definition at line 552 of file ComStubComponentAc.cpp.
|
protected |
Check whether port drvSendOut is connected
| portNum | The port number |
Definition at line 563 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_comStatusOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputSuccessConditionPort * | port | ||
| ) |
Connect port to comStatusOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 325 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_dataOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to dataOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 339 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_dataReturnOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputComDataWithContextPort * | port | ||
| ) |
Connect port to dataReturnOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 353 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_drvAsyncSendOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to drvAsyncSendOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 367 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_drvReceiveReturnOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to drvReceiveReturnOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 381 of file ComStubComponentAc.cpp.
| void Svc::ComStubComponentBase::set_drvSendOut_OutputPort | ( | FwIndexType | portNum, |
| Drv::InputByteStreamSendPort * | port | ||
| ) |
Connect port to drvSendOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 395 of file ComStubComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 40 of file ComStubComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 38 of file ComStubComponentAc.hpp.