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.

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

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

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

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

U32	getIdBase () const

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.

virtual	~CmdSplitterComponentBase ()
	Destroy CmdSplitterComponentBase object.

FwIndexType	getNum_CmdBuff_InputPorts () const

FwIndexType	getNum_seqCmdStatus_InputPorts () const

FwIndexType	getNum_LocalCmd_OutputPorts () const

FwIndexType	getNum_RemoteCmd_OutputPorts () const

FwIndexType	getNum_forwardSeqCmdStatus_OutputPorts () const

bool	isConnected_LocalCmd_OutputPort (FwIndexType portNum)

bool	isConnected_RemoteCmd_OutputPort (FwIndexType portNum)

bool	isConnected_forwardSeqCmdStatus_OutputPort (FwIndexType portNum)

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

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

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

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

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

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

void	forwardSeqCmdStatus_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Invoke output port forwardSeqCmdStatus.

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	CmdSplitterComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

Auto-generated base for CmdSplitter component.

A component for splitting incoming commands to local or remote

Definition at line 23 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 41 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 47 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 258 of file CmdSplitterComponentAc.cpp.

◆ ~CmdSplitterComponentBase()

Svc::CmdSplitterComponentBase::~CmdSplitterComponentBase ( )

protectedvirtual

Destroy CmdSplitterComponentBase object.

Definition at line 265 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 352 of file CmdSplitterComponentAc.cpp.

◆ forwardSeqCmdStatus_out()

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

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 434 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 136 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 147 of file CmdSplitterComponentAc.cpp.

◆ getNum_CmdBuff_InputPorts()

FwIndexType Svc::CmdSplitterComponentBase::getNum_CmdBuff_InputPorts ( ) const

protected

Get the number of CmdBuff input ports

Returns: The number of CmdBuff input ports

Definition at line 275 of file CmdSplitterComponentAc.cpp.

◆ getNum_forwardSeqCmdStatus_OutputPorts()

FwIndexType Svc::CmdSplitterComponentBase::getNum_forwardSeqCmdStatus_OutputPorts ( ) const

protected

Get the number of forwardSeqCmdStatus output ports

Returns: The number of forwardSeqCmdStatus output ports

Definition at line 303 of file CmdSplitterComponentAc.cpp.

◆ getNum_LocalCmd_OutputPorts()

FwIndexType Svc::CmdSplitterComponentBase::getNum_LocalCmd_OutputPorts ( ) const

protected

Get the number of LocalCmd output ports

Returns: The number of LocalCmd output ports

Definition at line 291 of file CmdSplitterComponentAc.cpp.

◆ getNum_RemoteCmd_OutputPorts()

FwIndexType Svc::CmdSplitterComponentBase::getNum_RemoteCmd_OutputPorts ( ) const

protected

Get the number of RemoteCmd output ports

Returns: The number of RemoteCmd output ports

Definition at line 297 of file CmdSplitterComponentAc.cpp.

◆ getNum_seqCmdStatus_InputPorts()

FwIndexType Svc::CmdSplitterComponentBase::getNum_seqCmdStatus_InputPorts ( ) const

protected

Get the number of seqCmdStatus input ports

Returns: The number of seqCmdStatus input ports

Definition at line 281 of file CmdSplitterComponentAc.cpp.

◆ init()

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

Initialize CmdSplitterComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file CmdSplitterComponentAc.cpp.

◆ isConnected_forwardSeqCmdStatus_OutputPort()

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

protected

Check whether port forwardSeqCmdStatus is connected

Returns: Whether port forwardSeqCmdStatus is connected

Parameters

portNum The port number

Definition at line 335 of file CmdSplitterComponentAc.cpp.

◆ isConnected_LocalCmd_OutputPort()

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

protected

Check whether port LocalCmd is connected

Returns: Whether port LocalCmd is connected

Parameters

portNum The port number

Definition at line 313 of file CmdSplitterComponentAc.cpp.

◆ isConnected_RemoteCmd_OutputPort()

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

protected

Check whether port RemoteCmd is connected

Returns: Whether port RemoteCmd is connected

Parameters

portNum The port number

Definition at line 324 of file CmdSplitterComponentAc.cpp.

◆ LocalCmd_out()

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

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 400 of file CmdSplitterComponentAc.cpp.

◆ RemoteCmd_out()

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

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 417 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 373 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 190 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 162 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 176 of file CmdSplitterComponentAc.cpp.

Friends And Related Symbol Documentation

◆ CmdSplitterComponentBaseFriend

friend class CmdSplitterComponentBaseFriend

friend

Friend class for white-box testing.

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

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 Symbol Documentation

◆ CmdSplitterComponentBaseFriend