#include <Svc/ComStub/ComStub.hpp>

Inheritance diagram for Svc::ComStub:

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.

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].

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.

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.

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)

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.

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.

virtual	~PassiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	Initialization function.

NATIVE_INT_TYPE	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.

virtual	~ObjBase ()
	Destructor.

void	init ()
	Object initializer.

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

compName The 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:

Svc/ComStub/ComStub.hpp
Svc/ComStub/ComStub.cpp

Public Member Functions