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

#include <Svc/ComRetry/ComRetryComponentAc.hpp>

Inheritance diagram for Svc::ComRetryComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize ComRetryComponentBase object. More...

Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_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...

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

FwIdType	getIdBase () const

Protected Types
enum	{ NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_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 }
	Enumerations for numbers of typed output ports. More...

Protected Member Functions
	ComRetryComponentBase (const char *compName="")
	Construct ComRetryComponentBase object. More...

virtual	~ComRetryComponentBase ()
	Destroy ComRetryComponentBase object. More...

bool	isConnected_comStatusOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)

virtual void	comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0
	Handler for input port comStatusIn. More...

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

void	comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn. 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	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...

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

Static Protected Member Functions
static constexpr FwIndexType	getNum_comStatusIn_InputPorts ()

static constexpr FwIndexType	getNum_dataIn_InputPorts ()

static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()

static constexpr FwIndexType	getNum_comStatusOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataReturnOut_OutputPorts ()

Friends
class	ComRetryTesterBase
	Friend class tester to support autocoded test harness. More...

class	ComRetryTester
	Friend class tester implementation to support white-box testing. More...

Detailed Description

Auto-generated base for ComRetry component.

A component for retrying message delivery on failure

Definition at line 23 of file ComRetryComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMSTATUSIN_INPUT_PORTS
NUM_DATAIN_INPUT_PORTS
NUM_DATARETURNIN_INPUT_PORTS

Definition at line 43 of file ComRetryComponentAc.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

Definition at line 50 of file ComRetryComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComRetryComponentBase()

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

protected

Construct ComRetryComponentBase object.

Parameters

compName The component name

Definition at line 294 of file ComRetryComponentAc.cpp.

◆ ~ComRetryComponentBase()

Svc::ComRetryComponentBase::~ComRetryComponentBase ( )

protectedvirtual

Destroy ComRetryComponentBase object.

Definition at line 301 of file ComRetryComponentAc.cpp.

Member Function Documentation

◆ comStatusIn_handler()

virtual void Svc::ComRetryComponentBase::comStatusIn_handler	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protectedpure virtual

Handler for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

◆ comStatusIn_handlerBase()

void Svc::ComRetryComponentBase::comStatusIn_handlerBase	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protected

Handler base-class function for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 350 of file ComRetryComponentAc.cpp.

◆ comStatusOut_out()

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

protected

Invoke output port comStatusOut.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 415 of file ComRetryComponentAc.cpp.

◆ dataIn_handler()

virtual void Svc::ComRetryComponentBase::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::ComRetryComponentBase::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 369 of file ComRetryComponentAc.cpp.

◆ dataOut_out()

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

protected

Invoke output port dataOut.

Parameters

portNum The port number

Definition at line 435 of file ComRetryComponentAc.cpp.

◆ dataReturnIn_handler()

virtual void Svc::ComRetryComponentBase::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::ComRetryComponentBase::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 390 of file ComRetryComponentAc.cpp.

◆ dataReturnOut_out()

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

protected

Invoke output port dataReturnOut.

Parameters

portNum The port number

Definition at line 457 of file ComRetryComponentAc.cpp.

◆ get_comStatusIn_InputPort()

Fw::InputSuccessConditionPort * Svc::ComRetryComponentBase::get_comStatusIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comStatusIn[portNum]

Parameters

portNum The port number

Definition at line 161 of file ComRetryComponentAc.cpp.

◆ get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComRetryComponentBase::get_dataIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: dataIn[portNum]

Parameters

portNum The port number

Definition at line 172 of file ComRetryComponentAc.cpp.

◆ get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComRetryComponentBase::get_dataReturnIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: dataReturnIn[portNum]

Parameters

portNum The port number

Definition at line 183 of file ComRetryComponentAc.cpp.

◆ getNum_comStatusIn_InputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_comStatusIn_InputPorts ( )

inlinestaticprotected

Get the number of comStatusIn input ports

Returns: The number of comStatusIn input ports

Definition at line 169 of file ComRetryComponentAc.hpp.

◆ getNum_comStatusOut_OutputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_comStatusOut_OutputPorts ( )

inlinestaticprotected

Get the number of comStatusOut output ports

Returns: The number of comStatusOut output ports

Definition at line 196 of file ComRetryComponentAc.hpp.

◆ getNum_dataIn_InputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_dataIn_InputPorts ( )

inlinestaticprotected

Get the number of dataIn input ports

Returns: The number of dataIn input ports

Definition at line 176 of file ComRetryComponentAc.hpp.

◆ getNum_dataOut_OutputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_dataOut_OutputPorts ( )

inlinestaticprotected

Get the number of dataOut output ports

Returns: The number of dataOut output ports

Definition at line 203 of file ComRetryComponentAc.hpp.

◆ getNum_dataReturnIn_InputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_dataReturnIn_InputPorts ( )

inlinestaticprotected

Get the number of dataReturnIn input ports

Returns: The number of dataReturnIn input ports

Definition at line 183 of file ComRetryComponentAc.hpp.

◆ getNum_dataReturnOut_OutputPorts()

static constexpr FwIndexType Svc::ComRetryComponentBase::getNum_dataReturnOut_OutputPorts ( )

inlinestaticprotected

Get the number of dataReturnOut output ports

Returns: The number of dataReturnOut output ports

Definition at line 210 of file ComRetryComponentAc.hpp.

◆ init()

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

Initialize ComRetryComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file ComRetryComponentAc.cpp.

◆ isConnected_comStatusOut_OutputPort()

bool Svc::ComRetryComponentBase::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 311 of file ComRetryComponentAc.cpp.

◆ isConnected_dataOut_OutputPort()

bool Svc::ComRetryComponentBase::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 322 of file ComRetryComponentAc.cpp.

◆ isConnected_dataReturnOut_OutputPort()

bool Svc::ComRetryComponentBase::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 333 of file ComRetryComponentAc.cpp.

◆ set_comStatusOut_OutputPort()

void Svc::ComRetryComponentBase::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 198 of file ComRetryComponentAc.cpp.

◆ set_dataOut_OutputPort()

void Svc::ComRetryComponentBase::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 212 of file ComRetryComponentAc.cpp.

◆ set_dataReturnOut_OutputPort()

void Svc::ComRetryComponentBase::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 226 of file ComRetryComponentAc.cpp.

Friends And Related Function Documentation

◆ ComRetryTester

friend class ComRetryTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 34 of file ComRetryComponentAc.hpp.

◆ ComRetryTesterBase

friend class ComRetryTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 32 of file ComRetryComponentAc.hpp.

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

Svc/ComRetry/ComRetryComponentAc.hpp
Svc/ComRetry/ComRetryComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ComRetryComponentBase()

◆ ~ComRetryComponentBase()

Member Function Documentation

◆ comStatusIn_handler()

◆ comStatusIn_handlerBase()

◆ comStatusOut_out()

◆ dataIn_handler()

◆ dataIn_handlerBase()

◆ dataOut_out()

◆ dataReturnIn_handler()

◆ dataReturnIn_handlerBase()

◆ dataReturnOut_out()

◆ get_comStatusIn_InputPort()

◆ get_dataIn_InputPort()

◆ get_dataReturnIn_InputPort()

◆ getNum_comStatusIn_InputPorts()

◆ getNum_comStatusOut_OutputPorts()

◆ getNum_dataIn_InputPorts()

◆ getNum_dataOut_OutputPorts()

◆ getNum_dataReturnIn_InputPorts()

◆ getNum_dataReturnOut_OutputPorts()

◆ init()

◆ isConnected_comStatusOut_OutputPort()

◆ isConnected_dataOut_OutputPort()

◆ isConnected_dataReturnOut_OutputPort()

◆ set_comStatusOut_OutputPort()

◆ set_dataOut_OutputPort()

◆ set_dataReturnOut_OutputPort()

Friends And Related Function Documentation

◆ ComRetryTester

◆ ComRetryTesterBase