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

#include <Svc/ComSplitter/ComSplitterComponentAc.hpp>

Inheritance diagram for Svc::ComSplitterComponentBase:

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

Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)

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

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

U32	getIdBase () const

Protected Types
enum	{ NUM_COMIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_COMOUT_OUTPUT_PORTS = 5 }
	Enumerations for numbers of typed output ports. More...

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

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

FwIndexType	getNum_comIn_InputPorts () const

FwIndexType	getNum_comOut_OutputPorts () const

bool	isConnected_comOut_OutputPort (FwIndexType portNum)

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

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

void	comOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port comOut. 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	ComSplitterComponentBaseFriend
	Friend class for white-box testing. More...

class	ComSplitterTesterBase
	Friend class tester to support autocoded test harness. More...

Detailed Description

Auto-generated base for ComSplitter component.

A component for splitting a Com buffer stream

Definition at line 22 of file ComSplitterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMIN_INPUT_PORTS

Definition at line 42 of file ComSplitterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMOUT_OUTPUT_PORTS

Definition at line 47 of file ComSplitterComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComSplitterComponentBase()

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

protected

Construct ComSplitterComponentBase object.

Parameters

compName The component name

Definition at line 130 of file ComSplitterComponentAc.cpp.

◆ ~ComSplitterComponentBase()

Svc::ComSplitterComponentBase::~ComSplitterComponentBase ( )

protectedvirtual

Destroy ComSplitterComponentBase object.

Definition at line 137 of file ComSplitterComponentAc.cpp.

Member Function Documentation

◆ comIn_handler()

virtual void Svc::ComSplitterComponentBase::comIn_handler	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedpure virtual

Handler for input port comIn.

Parameters

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

◆ comIn_handlerBase()

void Svc::ComSplitterComponentBase::comIn_handlerBase	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Handler base-class function for input port comIn.

Parameters

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

Definition at line 184 of file ComSplitterComponentAc.cpp.

◆ comOut_out()

void Svc::ComSplitterComponentBase::comOut_out	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Invoke output port comOut.

Parameters

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

Definition at line 209 of file ComSplitterComponentAc.cpp.

◆ get_comIn_InputPort()

Fw::InputComPort * Svc::ComSplitterComponentBase::get_comIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comIn[portNum]

Parameters

portNum The port number

Definition at line 75 of file ComSplitterComponentAc.cpp.

◆ getNum_comIn_InputPorts()

FwIndexType Svc::ComSplitterComponentBase::getNum_comIn_InputPorts ( ) const

protected

Get the number of comIn input ports

Returns: The number of comIn input ports

Definition at line 147 of file ComSplitterComponentAc.cpp.

◆ getNum_comOut_OutputPorts()

FwIndexType Svc::ComSplitterComponentBase::getNum_comOut_OutputPorts ( ) const

protected

Get the number of comOut output ports

Returns: The number of comOut output ports

Definition at line 157 of file ComSplitterComponentAc.cpp.

◆ init()

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

Initialize ComSplitterComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file ComSplitterComponentAc.cpp.

◆ isConnected_comOut_OutputPort()

bool Svc::ComSplitterComponentBase::isConnected_comOut_OutputPort ( FwIndexType portNum )

protected

Check whether port comOut is connected

Returns: Whether port comOut is connected

Parameters

portNum The port number

Definition at line 167 of file ComSplitterComponentAc.cpp.

◆ set_comOut_OutputPort()

void Svc::ComSplitterComponentBase::set_comOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to comOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 90 of file ComSplitterComponentAc.cpp.

Friends And Related Function Documentation

◆ ComSplitterComponentBaseFriend

friend class ComSplitterComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 31 of file ComSplitterComponentAc.hpp.

◆ ComSplitterTesterBase

friend class ComSplitterTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 33 of file ComSplitterComponentAc.hpp.

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

Svc/ComSplitter/ComSplitterComponentAc.hpp
Svc/ComSplitter/ComSplitterComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ComSplitterComponentBase()

◆ ~ComSplitterComponentBase()

Member Function Documentation

◆ comIn_handler()

◆ comIn_handlerBase()

◆ comOut_out()

◆ get_comIn_InputPort()

◆ getNum_comIn_InputPorts()

◆ getNum_comOut_OutputPorts()

◆ init()

◆ isConnected_comOut_OutputPort()

◆ set_comOut_OutputPort()

Friends And Related Function Documentation

◆ ComSplitterComponentBaseFriend

◆ ComSplitterTesterBase