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

#include <Svc/CmdSplitter/CmdSplitterComponentAc.hpp>

Inheritance diagram for Svc::CmdSplitterComponentBase:

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

Fw::InputComPort *	get_CmdBuff_InputPort (FwIndexType portNum)

Fw::InputCmdResponsePort *	get_seqCmdStatus_InputPort (FwIndexType portNum)

void	set_LocalCmd_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to LocalCmd[portNum]. More...

void	set_RemoteCmd_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to RemoteCmd[portNum]. More...

void	set_forwardSeqCmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to forwardSeqCmdStatus[portNum]. More...

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

FwIdType	getIdBase () const

virtual void	deinit ()
	Deinitialization function. More...

Protected Types
enum	{ NUM_CMDBUFF_INPUT_PORTS = 5, NUM_SEQCMDSTATUS_INPUT_PORTS = 5 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOCALCMD_OUTPUT_PORTS = 5, NUM_REMOTECMD_OUTPUT_PORTS = 5, NUM_FORWARDSEQCMDSTATUS_OUTPUT_PORTS = 5 }
	Enumerations for numbers of typed output ports. More...

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

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

bool	isConnected_LocalCmd_OutputPort (FwIndexType portNum) const

bool	isConnected_RemoteCmd_OutputPort (FwIndexType portNum) const

bool	isConnected_forwardSeqCmdStatus_OutputPort (FwIndexType portNum) const

virtual void	CmdBuff_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
	Handler for input port CmdBuff. More...

virtual void	seqCmdStatus_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
	Handler for input port seqCmdStatus. More...

void	CmdBuff_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port CmdBuff. More...

void	seqCmdStatus_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Handler base-class function for input port seqCmdStatus. More...

void	LocalCmd_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const
	Invoke output port LocalCmd. More...

void	RemoteCmd_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const
	Invoke output port RemoteCmd. More...

void	forwardSeqCmdStatus_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) const
	Invoke output port forwardSeqCmdStatus. 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_CmdBuff_InputPorts ()

static constexpr FwIndexType	getNum_seqCmdStatus_InputPorts ()

static constexpr FwIndexType	getNum_LocalCmd_OutputPorts ()

static constexpr FwIndexType	getNum_RemoteCmd_OutputPorts ()

static constexpr FwIndexType	getNum_forwardSeqCmdStatus_OutputPorts ()

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

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

Detailed Description

Auto-generated base for CmdSplitter component.

A component for splitting incoming commands to local or remote

Definition at line 27 of file CmdSplitterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CMDBUFF_INPUT_PORTS
NUM_SEQCMDSTATUS_INPUT_PORTS

Definition at line 47 of file CmdSplitterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_LOCALCMD_OUTPUT_PORTS
NUM_REMOTECMD_OUTPUT_PORTS
NUM_FORWARDSEQCMDSTATUS_OUTPUT_PORTS

Definition at line 53 of file CmdSplitterComponentAc.hpp.

Constructor & Destructor Documentation

◆ CmdSplitterComponentBase()

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

protected

Construct CmdSplitterComponentBase object.

Parameters

compName The component name

Definition at line 277 of file CmdSplitterComponentAc.cpp.

◆ ~CmdSplitterComponentBase()

Svc::CmdSplitterComponentBase::~CmdSplitterComponentBase ( )

protectedvirtual

Destroy CmdSplitterComponentBase object.

Definition at line 284 of file CmdSplitterComponentAc.cpp.

Member Function Documentation

◆ CmdBuff_handler()

virtual void Svc::CmdSplitterComponentBase::CmdBuff_handler	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedpure virtual

Handler for input port CmdBuff.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

◆ CmdBuff_handlerBase()

void Svc::CmdSplitterComponentBase::CmdBuff_handlerBase	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Handler base-class function for input port CmdBuff.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 337 of file CmdSplitterComponentAc.cpp.

◆ forwardSeqCmdStatus_out()

void Svc::CmdSplitterComponentBase::forwardSeqCmdStatus_out	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)		const

protected

Invoke output port forwardSeqCmdStatus.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 431 of file CmdSplitterComponentAc.cpp.

◆ get_CmdBuff_InputPort()

Fw::InputComPort * Svc::CmdSplitterComponentBase::get_CmdBuff_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: CmdBuff[portNum]

Parameters

portNum The port number

Definition at line 149 of file CmdSplitterComponentAc.cpp.

◆ get_seqCmdStatus_InputPort()

Fw::InputCmdResponsePort * Svc::CmdSplitterComponentBase::get_seqCmdStatus_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: seqCmdStatus[portNum]

Parameters

portNum The port number

Definition at line 160 of file CmdSplitterComponentAc.cpp.

◆ getNum_CmdBuff_InputPorts()

static constexpr FwIndexType Svc::CmdSplitterComponentBase::getNum_CmdBuff_InputPorts ( )

inlinestaticprotected

Get the number of CmdBuff input ports

Returns: The number of CmdBuff input ports

Definition at line 173 of file CmdSplitterComponentAc.hpp.

◆ getNum_forwardSeqCmdStatus_OutputPorts()

static constexpr FwIndexType Svc::CmdSplitterComponentBase::getNum_forwardSeqCmdStatus_OutputPorts ( )

inlinestaticprotected

Get the number of forwardSeqCmdStatus output ports

Returns: The number of forwardSeqCmdStatus output ports

Definition at line 207 of file CmdSplitterComponentAc.hpp.

◆ getNum_LocalCmd_OutputPorts()

static constexpr FwIndexType Svc::CmdSplitterComponentBase::getNum_LocalCmd_OutputPorts ( )

inlinestaticprotected

Get the number of LocalCmd output ports

Returns: The number of LocalCmd output ports

Definition at line 193 of file CmdSplitterComponentAc.hpp.

◆ getNum_RemoteCmd_OutputPorts()

static constexpr FwIndexType Svc::CmdSplitterComponentBase::getNum_RemoteCmd_OutputPorts ( )

inlinestaticprotected

Get the number of RemoteCmd output ports

Returns: The number of RemoteCmd output ports

Definition at line 200 of file CmdSplitterComponentAc.hpp.

◆ getNum_seqCmdStatus_InputPorts()

static constexpr FwIndexType Svc::CmdSplitterComponentBase::getNum_seqCmdStatus_InputPorts ( )

inlinestaticprotected

Get the number of seqCmdStatus input ports

Returns: The number of seqCmdStatus input ports

Definition at line 180 of file CmdSplitterComponentAc.hpp.

◆ init()

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

Initialize CmdSplitterComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file CmdSplitterComponentAc.cpp.

◆ isConnected_forwardSeqCmdStatus_OutputPort()

bool Svc::CmdSplitterComponentBase::isConnected_forwardSeqCmdStatus_OutputPort ( FwIndexType portNum ) const

protected

Check whether port forwardSeqCmdStatus is connected

Returns: Whether port forwardSeqCmdStatus is connected

Parameters

portNum The port number

Definition at line 318 of file CmdSplitterComponentAc.cpp.

◆ isConnected_LocalCmd_OutputPort()

bool Svc::CmdSplitterComponentBase::isConnected_LocalCmd_OutputPort ( FwIndexType portNum ) const

protected

Check whether port LocalCmd is connected

Returns: Whether port LocalCmd is connected

Parameters

portNum The port number

Definition at line 296 of file CmdSplitterComponentAc.cpp.

◆ isConnected_RemoteCmd_OutputPort()

bool Svc::CmdSplitterComponentBase::isConnected_RemoteCmd_OutputPort ( FwIndexType portNum ) const

protected

Check whether port RemoteCmd is connected

Returns: Whether port RemoteCmd is connected

Parameters

portNum The port number

Definition at line 307 of file CmdSplitterComponentAc.cpp.

◆ LocalCmd_out()

void Svc::CmdSplitterComponentBase::LocalCmd_out	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)		const

protected

Invoke output port LocalCmd.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 387 of file CmdSplitterComponentAc.cpp.

◆ RemoteCmd_out()

void Svc::CmdSplitterComponentBase::RemoteCmd_out	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)		const

protected

Invoke output port RemoteCmd.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 409 of file CmdSplitterComponentAc.cpp.

◆ seqCmdStatus_handler()

virtual void Svc::CmdSplitterComponentBase::seqCmdStatus_handler	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protectedpure virtual

Handler for input port seqCmdStatus.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

◆ seqCmdStatus_handlerBase()

void Svc::CmdSplitterComponentBase::seqCmdStatus_handlerBase	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protected

Handler base-class function for input port seqCmdStatus.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 358 of file CmdSplitterComponentAc.cpp.

◆ set_forwardSeqCmdStatus_OutputPort()

void Svc::CmdSplitterComponentBase::set_forwardSeqCmdStatus_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to forwardSeqCmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 207 of file CmdSplitterComponentAc.cpp.

◆ set_LocalCmd_OutputPort()

void Svc::CmdSplitterComponentBase::set_LocalCmd_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to LocalCmd[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 179 of file CmdSplitterComponentAc.cpp.

◆ set_RemoteCmd_OutputPort()

void Svc::CmdSplitterComponentBase::set_RemoteCmd_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to RemoteCmd[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 193 of file CmdSplitterComponentAc.cpp.

Friends And Related Function Documentation

◆ CmdSplitterTester

friend class CmdSplitterTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 38 of file CmdSplitterComponentAc.hpp.

◆ CmdSplitterTesterBase

friend class CmdSplitterTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 36 of file CmdSplitterComponentAc.hpp.

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

Svc/CmdSplitter/CmdSplitterComponentAc.hpp
Svc/CmdSplitter/CmdSplitterComponentAc.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

◆ CmdSplitterComponentBase()

◆ ~CmdSplitterComponentBase()

Member Function Documentation

◆ CmdBuff_handler()

◆ CmdBuff_handlerBase()

◆ forwardSeqCmdStatus_out()

◆ get_CmdBuff_InputPort()

◆ get_seqCmdStatus_InputPort()

◆ getNum_CmdBuff_InputPorts()

◆ getNum_forwardSeqCmdStatus_OutputPorts()

◆ getNum_LocalCmd_OutputPorts()

◆ getNum_RemoteCmd_OutputPorts()

◆ getNum_seqCmdStatus_InputPorts()

◆ init()

◆ isConnected_forwardSeqCmdStatus_OutputPort()

◆ isConnected_LocalCmd_OutputPort()

◆ isConnected_RemoteCmd_OutputPort()

◆ LocalCmd_out()

◆ RemoteCmd_out()

◆ seqCmdStatus_handler()

◆ seqCmdStatus_handlerBase()

◆ set_forwardSeqCmdStatus_OutputPort()

◆ set_LocalCmd_OutputPort()

◆ set_RemoteCmd_OutputPort()

Friends And Related Function Documentation

◆ CmdSplitterTester

◆ CmdSplitterTesterBase