#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. More...

Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)

Drv::InputByteStreamReadyPort *	get_drvConnected_InputPort (FwIndexType portNum)

Drv::InputByteStreamDataPort *	get_drvReceiveIn_InputPort (FwIndexType portNum)

Drv::InputByteStreamDataPort *	get_drvSendReturnIn_InputPort (FwIndexType portNum)

void	set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
	Connect port to comStatusOut[portNum]. More...

void	set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataOut[portNum]. More...

void	set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataReturnOut[portNum]. More...

void	set_drvReceiveReturnOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to drvReceiveReturnOut[portNum]. More...

void	set_drvSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to drvSendOut[portNum]. More...

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

U32	getIdBase () const

Public Attributes
const FwIndexType	RETRY_LIMIT = 10

Friends
class	ComStubTester
	Allow UT Tester to access private members. More...

Additional Inherited Members
Protected Types inherited from Svc::ComStubComponentBase
enum	{ NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1, NUM_DRVCONNECTED_INPUT_PORTS = 1, NUM_DRVRECEIVEIN_INPUT_PORTS = 1, NUM_DRVSENDRETURNIN_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_DRVRECEIVERETURNOUT_OUTPUT_PORTS = 1, NUM_DRVSENDOUT_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_dataIn_InputPorts () const

FwIndexType	getNum_dataReturnIn_InputPorts () const

FwIndexType	getNum_drvConnected_InputPorts () const

FwIndexType	getNum_drvReceiveIn_InputPorts () const

FwIndexType	getNum_drvSendReturnIn_InputPorts () const

FwIndexType	getNum_comStatusOut_OutputPorts () const

FwIndexType	getNum_dataOut_OutputPorts () const

FwIndexType	getNum_dataReturnOut_OutputPorts () const

FwIndexType	getNum_drvReceiveReturnOut_OutputPorts () const

FwIndexType	getNum_drvSendOut_OutputPorts () const

bool	isConnected_comStatusOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)

bool	isConnected_drvReceiveReturnOut_OutputPort (FwIndexType portNum)

bool	isConnected_drvSendOut_OutputPort (FwIndexType portNum)

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	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	drvSendReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
	Handler base-class function for input port drvSendReturnIn. 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	drvReceiveReturnOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port drvReceiveReturnOut. More...

void	drvSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	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...

Detailed Description

Definition at line 15 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 18 of file ComStub.cpp.

◆ ~ComStub()

Svc::ComStub::~ComStub ( )

override

Destroy object ComStub

Definition at line 20 of file ComStub.cpp.

Friends And Related Function Documentation

◆ ComStubTester

friend class ComStubTester

friend

Allow UT Tester to access private members.

Definition at line 16 of file ComStub.hpp.

Member Data Documentation

◆ RETRY_LIMIT

const FwIndexType Svc::ComStub::RETRY_LIMIT = 10

Definition at line 19 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

Public Attributes

Friends

Additional Inherited Members