Svc::ComSplitterComponentBase Class Reference

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.
Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)
void	set_comOut_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to comOut[portNum].
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
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.
virtual	~ComSplitterComponentBase ()
	Destroy ComSplitterComponentBase object.
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.
void	comIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comIn.
void	comOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port comOut.
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	ComSplitterComponentBaseFriend
	Friend class for white-box testing.

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 40 of file ComSplitterComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMOUT_OUTPUT_PORTS

Definition at line 45 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 129 of file ComSplitterComponentAc.cpp.

~ComSplitterComponentBase()

Svc::ComSplitterComponentBase::~ComSplitterComponentBase ( )

protectedvirtual

Destroy ComSplitterComponentBase object.

Definition at line 136 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 183 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 208 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 74 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 146 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 156 of file ComSplitterComponentAc.cpp.

init()

void Svc::ComSplitterComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize ComSplitterComponentBase object.

Parameters

instance

The instance number

Definition at line 20 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 166 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 89 of file ComSplitterComponentAc.cpp.

Friends And Related Symbol Documentation

ComSplitterComponentBaseFriend

friend class ComSplitterComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 31 of file ComSplitterComponentAc.hpp.

---

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

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