![]() |
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>
Public Member Functions | |
void | init (FwEnumStoreType instance=0) |
Initialize ComStubComponentBase object. | |
Drv::InputByteStreamSendPort * | get_comDataIn_InputPort (FwIndexType portNum) |
Drv::InputByteStreamReadyPort * | get_drvConnected_InputPort (FwIndexType portNum) |
Drv::InputByteStreamRecvPort * | get_drvDataIn_InputPort (FwIndexType portNum) |
void | set_comDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *port) |
Connect port to comDataOut[portNum]. | |
void | set_comStatus_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port) |
Connect port to comStatus[portNum]. | |
void | set_drvDataOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port) |
Connect port to drvDataOut[portNum]. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
Protected Types | |
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 | |
ComStubComponentBase (const char *compName="") | |
Construct ComStubComponentBase object. | |
virtual | ~ComStubComponentBase () |
Destroy ComStubComponentBase object. | |
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) |
virtual Drv::SendStatus | comDataIn_handler (FwIndexType portNum, Fw::Buffer &sendBuffer)=0 |
Handler for input port comDataIn. | |
virtual void | drvConnected_handler (FwIndexType portNum)=0 |
Handler for input port drvConnected. | |
virtual void | drvDataIn_handler (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)=0 |
Handler for input port drvDataIn. | |
Drv::SendStatus | comDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &sendBuffer) |
Handler base-class function for input port comDataIn. | |
void | drvConnected_handlerBase (FwIndexType portNum) |
Handler base-class function for input port drvConnected. | |
void | drvDataIn_handlerBase (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus) |
Handler base-class function for input port drvDataIn. | |
void | comDataOut_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus) |
Invoke output port comDataOut. | |
void | comStatus_out (FwIndexType portNum, Fw::Success &condition) |
Invoke output port comStatus. | |
Drv::SendStatus | drvDataOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer) |
Invoke output port drvDataOut. | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. | |
virtual | ~PassiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. | |
virtual | ~ObjBase () |
Destructor. | |
void | init () |
Object initializer. | |
Friends | |
class | ComStubComponentBaseFriend |
Friend class for white-box testing. | |
Auto-generated base for ComStub component.
Communication adapter interface implementing communication adapter interface via a Drv.ByteStreamDriverModel.
Definition at line 25 of file ComStubComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_COMDATAIN_INPUT_PORTS | |
NUM_DRVCONNECTED_INPUT_PORTS | |
NUM_DRVDATAIN_INPUT_PORTS |
Definition at line 43 of file ComStubComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_COMDATAOUT_OUTPUT_PORTS | |
NUM_COMSTATUS_OUTPUT_PORTS | |
NUM_DRVDATAOUT_OUTPUT_PORTS |
Definition at line 50 of file ComStubComponentAc.hpp.
|
protected |
Construct ComStubComponentBase object.
compName | The component name |
Definition at line 279 of file ComStubComponentAc.cpp.
|
protectedvirtual |
Destroy ComStubComponentBase object.
Definition at line 286 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port comDataIn.
portNum | The port number |
sendBuffer | Data to send |
|
protected |
Handler base-class function for input port comDataIn.
portNum | The port number |
sendBuffer | Data to send |
Definition at line 379 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port comDataOut.
portNum | The port number |
Definition at line 440 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port comStatus.
portNum | The port number |
condition | Condition success/failure |
Definition at line 457 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 402 of file ComStubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port drvDataIn.
portNum | The port number |
|
protected |
Handler base-class function for input port drvDataIn.
portNum | The port number |
Definition at line 415 of file ComStubComponentAc.cpp.
|
protected |
Invoke output port drvDataOut.
portNum | The port number |
sendBuffer | Data to send |
Definition at line 472 of file ComStubComponentAc.cpp.
Drv::InputByteStreamSendPort * Svc::ComStubComponentBase::get_comDataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 160 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 171 of file ComStubComponentAc.cpp.
Drv::InputByteStreamRecvPort * Svc::ComStubComponentBase::get_drvDataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 182 of file ComStubComponentAc.cpp.
|
protected |
Get the number of comDataIn input ports
Definition at line 296 of file ComStubComponentAc.cpp.
|
protected |
Get the number of comDataOut output ports
Definition at line 318 of file ComStubComponentAc.cpp.
|
protected |
Get the number of comStatus output ports
Definition at line 324 of file ComStubComponentAc.cpp.
|
protected |
Get the number of drvConnected input ports
Definition at line 302 of file ComStubComponentAc.cpp.
|
protected |
Get the number of drvDataIn input ports
Definition at line 308 of file ComStubComponentAc.cpp.
|
protected |
Get the number of drvDataOut output ports
Definition at line 330 of file ComStubComponentAc.cpp.
void Svc::ComStubComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize ComStubComponentBase object.
instance | The instance number |
Definition at line 20 of file ComStubComponentAc.cpp.
|
protected |
Check whether port comDataOut is connected
portNum | The port number |
Definition at line 340 of file ComStubComponentAc.cpp.
|
protected |
Check whether port comStatus is connected
portNum | The port number |
Definition at line 351 of file ComStubComponentAc.cpp.
|
protected |
Check whether port drvDataOut is connected
portNum | The port number |
Definition at line 362 of file ComStubComponentAc.cpp.
void Svc::ComStubComponentBase::set_comDataOut_OutputPort | ( | FwIndexType | portNum, |
Drv::InputByteStreamRecvPort * | port | ||
) |
Connect port to comDataOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 197 of file ComStubComponentAc.cpp.
void Svc::ComStubComponentBase::set_comStatus_OutputPort | ( | FwIndexType | portNum, |
Fw::InputSuccessConditionPort * | port | ||
) |
Connect port to comStatus[portNum].
portNum | The port number |
port | The input port |
Definition at line 211 of file ComStubComponentAc.cpp.
void Svc::ComStubComponentBase::set_drvDataOut_OutputPort | ( | FwIndexType | portNum, |
Drv::InputByteStreamSendPort * | port | ||
) |
Connect port to drvDataOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 225 of file ComStubComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 34 of file ComStubComponentAc.hpp.