Svc::ComStubComponentBase Class Reference

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. More...
Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)
Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)
Drv::InputByteStreamDataPort *	get_drvAsyncSendReturnIn_InputPort (FwIndexType portNum)
Drv::InputByteStreamReadyPort *	get_drvConnected_InputPort (FwIndexType portNum)
Drv::InputByteStreamDataPort *	get_drvReceiveIn_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_drvAsyncSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to drvAsyncSendOut[portNum]. More...
void	set_drvReceiveReturnOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to drvReceiveReturnOut[portNum]. More...
void	set_drvSendOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port)
	Connect port to drvSendOut[portNum]. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	getIdBase () const

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...
FwIndexType	getNum_dataIn_InputPorts () const
FwIndexType	getNum_dataReturnIn_InputPorts () const
FwIndexType	getNum_drvAsyncSendReturnIn_InputPorts () const
FwIndexType	getNum_drvConnected_InputPorts () const
FwIndexType	getNum_drvReceiveIn_InputPorts () const
FwIndexType	getNum_comStatusOut_OutputPorts () const
FwIndexType	getNum_dataOut_OutputPorts () const
FwIndexType	getNum_dataReturnOut_OutputPorts () const
FwIndexType	getNum_drvAsyncSendOut_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_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...

Friends
class	ComStubTesterBase
	Friend class tester to support autocoded test harness. More...
class	ComStubTester
	Friend class tester implementation to support white-box testing. More...

Detailed Description

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.

Member Enumeration Documentation

anonymous enum

anonymous enum

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.

anonymous enum

anonymous enum

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.

Constructor & Destructor Documentation

ComStubComponentBase()

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

protected

Construct ComStubComponentBase object.

Parameters

compName

The component name

Definition at line 491 of file ComStubComponentAc.cpp.

~ComStubComponentBase()

Svc::ComStubComponentBase::~ComStubComponentBase ( )

protectedvirtual

Destroy ComStubComponentBase object.

Definition at line 498 of file ComStubComponentAc.cpp.

Member Function Documentation

comStatusOut_out()

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

protected

Invoke output port comStatusOut.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 755 of file ComStubComponentAc.cpp.

dataIn_handler()

virtual void Svc::ComStubComponentBase::dataIn_handler ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protectedpure virtual

Handler for input port dataIn.

Parameters

portNum

The port number

dataIn_handlerBase()

void Svc::ComStubComponentBase::dataIn_handlerBase ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protected

Handler base-class function for input port dataIn.

Parameters

portNum

The port number

Definition at line 654 of file ComStubComponentAc.cpp.

dataOut_out()

void Svc::ComStubComponentBase::dataOut_out ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protected

Invoke output port dataOut.

Parameters

portNum

The port number

Definition at line 775 of file ComStubComponentAc.cpp.

dataReturnIn_handler()

virtual void Svc::ComStubComponentBase::dataReturnIn_handler ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protectedpure virtual

Handler for input port dataReturnIn.

Parameters

portNum

The port number

dataReturnIn_handlerBase()

void Svc::ComStubComponentBase::dataReturnIn_handlerBase ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protected

Handler base-class function for input port dataReturnIn.

Parameters

portNum

The port number

Definition at line 675 of file ComStubComponentAc.cpp.

dataReturnOut_out()

void Svc::ComStubComponentBase::dataReturnOut_out ( FwIndexType  portNum, Fw::Buffer &  data, const ComCfg::FrameContext &  context  )

protected

Invoke output port dataReturnOut.

Parameters

portNum

The port number

Definition at line 797 of file ComStubComponentAc.cpp.

drvAsyncSendOut_out()

void Svc::ComStubComponentBase::drvAsyncSendOut_out ( FwIndexType  portNum, Fw::Buffer &  fwBuffer  )

protected

Invoke output port drvAsyncSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 819 of file ComStubComponentAc.cpp.

drvAsyncSendReturnIn_handler()

virtual void Svc::ComStubComponentBase::drvAsyncSendReturnIn_handler ( FwIndexType  portNum, Fw::Buffer &  buffer, const Drv::ByteStreamStatus &  status  )

protectedpure virtual

Handler for input port drvAsyncSendReturnIn.

Parameters

portNum

The port number

drvAsyncSendReturnIn_handlerBase()

void Svc::ComStubComponentBase::drvAsyncSendReturnIn_handlerBase ( FwIndexType  portNum, Fw::Buffer &  buffer, const Drv::ByteStreamStatus &  status  )

protected

Handler base-class function for input port drvAsyncSendReturnIn.

Parameters

portNum

The port number

Definition at line 696 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 717 of file ComStubComponentAc.cpp.

drvReceiveIn_handler()

virtual void Svc::ComStubComponentBase::drvReceiveIn_handler ( FwIndexType  portNum, Fw::Buffer &  buffer, const Drv::ByteStreamStatus &  status  )

protectedpure virtual

Handler for input port drvReceiveIn.

Parameters

portNum

The port number

drvReceiveIn_handlerBase()

void Svc::ComStubComponentBase::drvReceiveIn_handlerBase ( FwIndexType  portNum, Fw::Buffer &  buffer, const Drv::ByteStreamStatus &  status  )

protected

Handler base-class function for input port drvReceiveIn.

Parameters

portNum

The port number

Definition at line 730 of file ComStubComponentAc.cpp.

drvReceiveReturnOut_out()

void Svc::ComStubComponentBase::drvReceiveReturnOut_out ( FwIndexType  portNum, Fw::Buffer &  fwBuffer  )

protected

Invoke output port drvReceiveReturnOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 839 of file ComStubComponentAc.cpp.

drvSendOut_out()

Drv::ByteStreamStatus Svc::ComStubComponentBase::drvSendOut_out ( FwIndexType  portNum, Fw::Buffer &  sendBuffer  )

protected

Invoke output port drvSendOut.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 859 of file ComStubComponentAc.cpp.

get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

dataIn[portNum]

Parameters

portNum

The port number

Definition at line 266 of file ComStubComponentAc.cpp.

get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComStubComponentBase::get_dataReturnIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

dataReturnIn[portNum]

Parameters

portNum

The port number

Definition at line 277 of file ComStubComponentAc.cpp.

get_drvAsyncSendReturnIn_InputPort()

Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvAsyncSendReturnIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

drvAsyncSendReturnIn[portNum]

Parameters

portNum

The port number

Definition at line 288 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 299 of file ComStubComponentAc.cpp.

get_drvReceiveIn_InputPort()

Drv::InputByteStreamDataPort * Svc::ComStubComponentBase::get_drvReceiveIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

drvReceiveIn[portNum]

Parameters

portNum

The port number

Definition at line 310 of file ComStubComponentAc.cpp.

getNum_comStatusOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_comStatusOut_OutputPorts ( ) const

protected

Get the number of comStatusOut output ports

Returns

The number of comStatusOut output ports

Definition at line 542 of file ComStubComponentAc.cpp.

getNum_dataIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_dataIn_InputPorts ( ) const

protected

Get the number of dataIn input ports

Returns

The number of dataIn input ports

Definition at line 508 of file ComStubComponentAc.cpp.

getNum_dataOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_dataOut_OutputPorts ( ) const

protected

Get the number of dataOut output ports

Returns

The number of dataOut output ports

Definition at line 548 of file ComStubComponentAc.cpp.

getNum_dataReturnIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_dataReturnIn_InputPorts ( ) const

protected

Get the number of dataReturnIn input ports

Returns

The number of dataReturnIn input ports

Definition at line 514 of file ComStubComponentAc.cpp.

getNum_dataReturnOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_dataReturnOut_OutputPorts ( ) const

protected

Get the number of dataReturnOut output ports

Returns

The number of dataReturnOut output ports

Definition at line 554 of file ComStubComponentAc.cpp.

getNum_drvAsyncSendOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvAsyncSendOut_OutputPorts ( ) const

protected

Get the number of drvAsyncSendOut output ports

Returns

The number of drvAsyncSendOut output ports

Definition at line 560 of file ComStubComponentAc.cpp.

getNum_drvAsyncSendReturnIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvAsyncSendReturnIn_InputPorts ( ) const

protected

Get the number of drvAsyncSendReturnIn input ports

Returns

The number of drvAsyncSendReturnIn input ports

Definition at line 520 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 526 of file ComStubComponentAc.cpp.

getNum_drvReceiveIn_InputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvReceiveIn_InputPorts ( ) const

protected

Get the number of drvReceiveIn input ports

Returns

The number of drvReceiveIn input ports

Definition at line 532 of file ComStubComponentAc.cpp.

getNum_drvReceiveReturnOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvReceiveReturnOut_OutputPorts ( ) const

protected

Get the number of drvReceiveReturnOut output ports

Returns

The number of drvReceiveReturnOut output ports

Definition at line 566 of file ComStubComponentAc.cpp.

getNum_drvSendOut_OutputPorts()

FwIndexType Svc::ComStubComponentBase::getNum_drvSendOut_OutputPorts ( ) const

protected

Get the number of drvSendOut output ports

Returns

The number of drvSendOut output ports

Definition at line 572 of file ComStubComponentAc.cpp.

init()

void Svc::ComStubComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize ComStubComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file ComStubComponentAc.cpp.

isConnected_comStatusOut_OutputPort()

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

protected

Check whether port comStatusOut is connected

Returns

Whether port comStatusOut is connected

Parameters

portNum

The port number

Definition at line 582 of file ComStubComponentAc.cpp.

isConnected_dataOut_OutputPort()

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

protected

Check whether port dataOut is connected

Returns

Whether port dataOut is connected

Parameters

portNum

The port number

Definition at line 593 of file ComStubComponentAc.cpp.

isConnected_dataReturnOut_OutputPort()

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

protected

Check whether port dataReturnOut is connected

Returns

Whether port dataReturnOut is connected

Parameters

portNum

The port number

Definition at line 604 of file ComStubComponentAc.cpp.

isConnected_drvAsyncSendOut_OutputPort()

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

protected

Check whether port drvAsyncSendOut is connected

Returns

Whether port drvAsyncSendOut is connected

Parameters

portNum

The port number

Definition at line 615 of file ComStubComponentAc.cpp.

isConnected_drvReceiveReturnOut_OutputPort()

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

protected

Check whether port drvReceiveReturnOut is connected

Returns

Whether port drvReceiveReturnOut is connected

Parameters

portNum

The port number

Definition at line 626 of file ComStubComponentAc.cpp.

isConnected_drvSendOut_OutputPort()

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

protected

Check whether port drvSendOut is connected

Returns

Whether port drvSendOut is connected

Parameters

portNum

The port number

Definition at line 637 of file ComStubComponentAc.cpp.

set_comStatusOut_OutputPort()

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

Connect port to comStatusOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 325 of file ComStubComponentAc.cpp.

set_dataOut_OutputPort()

void Svc::ComStubComponentBase::set_dataOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputComDataWithContextPort *	port
	)

Connect port to dataOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 339 of file ComStubComponentAc.cpp.

set_dataReturnOut_OutputPort()

void Svc::ComStubComponentBase::set_dataReturnOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputComDataWithContextPort *	port
	)

Connect port to dataReturnOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 353 of file ComStubComponentAc.cpp.

set_drvAsyncSendOut_OutputPort()

void Svc::ComStubComponentBase::set_drvAsyncSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to drvAsyncSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 367 of file ComStubComponentAc.cpp.

set_drvReceiveReturnOut_OutputPort()

void Svc::ComStubComponentBase::set_drvReceiveReturnOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to drvReceiveReturnOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 381 of file ComStubComponentAc.cpp.

set_drvSendOut_OutputPort()

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

Connect port to drvSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 395 of file ComStubComponentAc.cpp.

Friends And Related Function Documentation

ComStubTester

friend class ComStubTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 40 of file ComStubComponentAc.hpp.

ComStubTesterBase

friend class ComStubTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 38 of file ComStubComponentAc.hpp.

---

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

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