Auto-generated base for ComStub component. More...

#include <Svc/ComStub/ComStubComponentAc.hpp>

Inheritance diagram for Svc::ComStubComponentBase:

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

Public Member Functions inherited from Fw::PassiveComponentBase
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.

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.

Friends
class	ComStubComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

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.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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.

◆ anonymous enum

anonymous enum

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.

Constructor & Destructor Documentation

◆ ComStubComponentBase()

Svc::ComStubComponentBase::ComStubComponentBase ( const char * compName = "" )

protected

Construct ComStubComponentBase object.

Parameters

compName The component name

Definition at line 279 of file ComStubComponentAc.cpp.

◆ ~ComStubComponentBase()

Svc::ComStubComponentBase::~ComStubComponentBase ( )

protectedvirtual

Destroy ComStubComponentBase object.

Definition at line 286 of file ComStubComponentAc.cpp.

Member Function Documentation

◆ comDataIn_handler()

virtual Drv::SendStatus Svc::ComStubComponentBase::comDataIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protectedpure virtual

Handler for input port comDataIn.

Parameters

portNum	The port number
sendBuffer	Data to send

◆ comDataIn_handlerBase()

Drv::SendStatus Svc::ComStubComponentBase::comDataIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protected

Handler base-class function for input port comDataIn.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 379 of file ComStubComponentAc.cpp.

◆ comDataOut_out()

void Svc::ComStubComponentBase::comDataOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protected

Invoke output port comDataOut.

Parameters

portNum The port number

Definition at line 440 of file ComStubComponentAc.cpp.

◆ comStatus_out()

void Svc::ComStubComponentBase::comStatus_out	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protected

Invoke output port comStatus.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 457 of file ComStubComponentAc.cpp.

◆ drvConnected_handler()

virtual void Svc::ComStubComponentBase::drvConnected_handler ( FwIndexType portNum )

protectedpure virtual

Handler for input port drvConnected.

Parameters

portNum The port number

◆ drvConnected_handlerBase()

void Svc::ComStubComponentBase::drvConnected_handlerBase ( FwIndexType portNum )

protected

Handler base-class function for input port drvConnected.

Parameters

portNum The port number

Definition at line 402 of file ComStubComponentAc.cpp.

◆ drvDataIn_handler()

virtual void Svc::ComStubComponentBase::drvDataIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protectedpure virtual

Handler for input port drvDataIn.

Parameters

portNum The port number

◆ drvDataIn_handlerBase()

void Svc::ComStubComponentBase::drvDataIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protected

Handler base-class function for input port drvDataIn.

Parameters

portNum The port number

Definition at line 415 of file ComStubComponentAc.cpp.

◆ drvDataOut_out()

Drv::SendStatus Svc::ComStubComponentBase::drvDataOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protected

Invoke output port drvDataOut.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 472 of file ComStubComponentAc.cpp.

◆ get_comDataIn_InputPort()

Drv::InputByteStreamSendPort * Svc::ComStubComponentBase::get_comDataIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comDataIn[portNum]

Parameters

portNum The port number

Definition at line 160 of file ComStubComponentAc.cpp.

◆ get_drvConnected_InputPort()

Drv::InputByteStreamReadyPort * Svc::ComStubComponentBase::get_drvConnected_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: drvConnected[portNum]

Parameters

portNum The port number

Definition at line 171 of file ComStubComponentAc.cpp.

◆ get_drvDataIn_InputPort()

Drv::InputByteStreamRecvPort * Svc::ComStubComponentBase::get_drvDataIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: drvDataIn[portNum]

Parameters

portNum The port number

Definition at line 182 of file ComStubComponentAc.cpp.

◆ getNum_comDataIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comDataIn_InputPorts ( ) const

protected

Get the number of comDataIn input ports

Returns: The number of comDataIn input ports

Definition at line 296 of file ComStubComponentAc.cpp.

◆ getNum_comDataOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comDataOut_OutputPorts ( ) const

protected

Get the number of comDataOut output ports

Returns: The number of comDataOut output ports

Definition at line 318 of file ComStubComponentAc.cpp.

◆ getNum_comStatus_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comStatus_OutputPorts ( ) const

protected

Get the number of comStatus output ports

Returns: The number of comStatus output ports

Definition at line 324 of file ComStubComponentAc.cpp.

◆ getNum_drvConnected_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvConnected_InputPorts ( ) const

protected

Get the number of drvConnected input ports

Returns: The number of drvConnected input ports

Definition at line 302 of file ComStubComponentAc.cpp.

◆ getNum_drvDataIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvDataIn_InputPorts ( ) const

protected

Get the number of drvDataIn input ports

Returns: The number of drvDataIn input ports

Definition at line 308 of file ComStubComponentAc.cpp.

◆ getNum_drvDataOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvDataOut_OutputPorts ( ) const

protected

Get the number of drvDataOut output ports

Returns: The number of drvDataOut output ports

Definition at line 330 of file ComStubComponentAc.cpp.

◆ init()

void Svc::ComStubComponentBase::init ( FwEnumStoreType instance = 0 )

Initialize ComStubComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file ComStubComponentAc.cpp.

◆ isConnected_comDataOut_OutputPort()

bool Svc::ComStubComponentBase::isConnected_comDataOut_OutputPort ( FwIndexType portNum )

protected

Check whether port comDataOut is connected

Returns: Whether port comDataOut is connected

Parameters

portNum The port number

Definition at line 340 of file ComStubComponentAc.cpp.

◆ isConnected_comStatus_OutputPort()

bool Svc::ComStubComponentBase::isConnected_comStatus_OutputPort ( FwIndexType portNum )

protected

Check whether port comStatus is connected

Returns: Whether port comStatus is connected

Parameters

portNum The port number

Definition at line 351 of file ComStubComponentAc.cpp.

◆ isConnected_drvDataOut_OutputPort()

bool Svc::ComStubComponentBase::isConnected_drvDataOut_OutputPort ( FwIndexType portNum )

protected

Check whether port drvDataOut is connected

Returns: Whether port drvDataOut is connected

Parameters

portNum The port number

Definition at line 362 of file ComStubComponentAc.cpp.

◆ set_comDataOut_OutputPort()

void Svc::ComStubComponentBase::set_comDataOut_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamRecvPort *	port
	)

Connect port to comDataOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 197 of file ComStubComponentAc.cpp.

◆ set_comStatus_OutputPort()

void Svc::ComStubComponentBase::set_comStatus_OutputPort	(	FwIndexType	portNum,
		Fw::InputSuccessConditionPort *	port
	)

Connect port to comStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 211 of file ComStubComponentAc.cpp.

◆ set_drvDataOut_OutputPort()

void Svc::ComStubComponentBase::set_drvDataOut_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamSendPort *	port
	)

Connect port to drvDataOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 225 of file ComStubComponentAc.cpp.

Friends And Related Symbol Documentation

◆ ComStubComponentBaseFriend

friend class ComStubComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 34 of file ComStubComponentAc.hpp.

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

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

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ComStubComponentBase()

◆ ~ComStubComponentBase()

Member Function Documentation

◆ comDataIn_handler()

◆ comDataIn_handlerBase()

◆ comDataOut_out()

◆ comStatus_out()

◆ drvConnected_handler()

◆ drvConnected_handlerBase()

◆ drvDataIn_handler()

◆ drvDataIn_handlerBase()

◆ drvDataOut_out()

◆ get_comDataIn_InputPort()

◆ get_drvConnected_InputPort()

◆ get_drvDataIn_InputPort()

◆ getNum_comDataIn_InputPorts()

◆ getNum_comDataOut_OutputPorts()

◆ getNum_comStatus_OutputPorts()

◆ getNum_drvConnected_InputPorts()

◆ getNum_drvDataIn_InputPorts()

◆ getNum_drvDataOut_OutputPorts()

◆ init()

◆ isConnected_comDataOut_OutputPort()

◆ isConnected_comStatus_OutputPort()

◆ isConnected_drvDataOut_OutputPort()

◆ set_comDataOut_OutputPort()

◆ set_comStatus_OutputPort()

◆ set_drvDataOut_OutputPort()

Friends And Related Symbol Documentation

◆ ComStubComponentBaseFriend