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

#include <Drv/StreamCrossover/StreamCrossoverComponentAc.hpp>

Inheritance diagram for Drv::StreamCrossoverComponentBase:

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

Drv::InputByteStreamRecvPort *	get_streamIn_InputPort (FwIndexType portNum)

void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum]. More...

void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...

void	set_errorDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to errorDeallocate[portNum]. More...

void	set_streamOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port)
	Connect port to streamOut[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_STREAMIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_ERRORDEALLOCATE_OUTPUT_PORTS = 1, NUM_STREAMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_STREAMOUTERROR = 0x0 }
	Event IDs. More...

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

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

FwIndexType	getNum_streamIn_InputPorts () const

FwIndexType	getNum_logOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_errorDeallocate_OutputPorts () const

FwIndexType	getNum_streamOut_OutputPorts () const

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_errorDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_streamOut_OutputPort (FwIndexType portNum)

virtual void	streamIn_handler (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)=0
	Handler for input port streamIn. More...

void	streamIn_handlerBase (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
	Handler base-class function for input port streamIn. More...

void	errorDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port errorDeallocate. More...

Drv::SendStatus	streamOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer)
	Invoke output port streamOut. More...

void	log_WARNING_HI_StreamOutError (Drv::SendStatus sendStatus) const

Fw::Time	getTime ()

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	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	StreamCrossoverComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for StreamCrossover component.

Definition at line 29 of file StreamCrossoverComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_STREAMIN_INPUT_PORTS

Definition at line 47 of file StreamCrossoverComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGOUT_OUTPUT_PORTS
NUM_LOGTEXTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS

Definition at line 52 of file StreamCrossoverComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ERRORDEALLOCATE_OUTPUT_PORTS
NUM_STREAMOUT_OUTPUT_PORTS

Definition at line 59 of file StreamCrossoverComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_STREAMOUTERROR	Indicates buffer failed to send to streamOut.

Definition at line 65 of file StreamCrossoverComponentAc.hpp.

Constructor & Destructor Documentation

◆ StreamCrossoverComponentBase()

Drv::StreamCrossoverComponentBase::StreamCrossoverComponentBase ( const char * compName = "" )

protected

Construct StreamCrossoverComponentBase object.

Parameters

compName The component name

Definition at line 326 of file StreamCrossoverComponentAc.cpp.

◆ ~StreamCrossoverComponentBase()

Drv::StreamCrossoverComponentBase::~StreamCrossoverComponentBase ( )

protectedvirtual

Destroy StreamCrossoverComponentBase object.

Definition at line 333 of file StreamCrossoverComponentAc.cpp.

Member Function Documentation

◆ errorDeallocate_out()

void Drv::StreamCrossoverComponentBase::errorDeallocate_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port errorDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 489 of file StreamCrossoverComponentAc.cpp.

◆ get_streamIn_InputPort()

Drv::InputByteStreamRecvPort * Drv::StreamCrossoverComponentBase::get_streamIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: streamIn[portNum]

Parameters

portNum The port number

Definition at line 153 of file StreamCrossoverComponentAc.cpp.

◆ getNum_errorDeallocate_OutputPorts()

FwIndexType Drv::StreamCrossoverComponentBase::getNum_errorDeallocate_OutputPorts ( ) const

protected

Get the number of errorDeallocate output ports

Returns: The number of errorDeallocate output ports

Definition at line 379 of file StreamCrossoverComponentAc.cpp.

◆ getNum_logOut_OutputPorts()

FwIndexType Drv::StreamCrossoverComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 353 of file StreamCrossoverComponentAc.cpp.

◆ getNum_streamIn_InputPorts()

FwIndexType Drv::StreamCrossoverComponentBase::getNum_streamIn_InputPorts ( ) const

protected

Get the number of streamIn input ports

Returns: The number of streamIn input ports

Definition at line 343 of file StreamCrossoverComponentAc.cpp.

◆ getNum_streamOut_OutputPorts()

FwIndexType Drv::StreamCrossoverComponentBase::getNum_streamOut_OutputPorts ( ) const

protected

Get the number of streamOut output ports

Returns: The number of streamOut output ports

Definition at line 385 of file StreamCrossoverComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Drv::StreamCrossoverComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 369 of file StreamCrossoverComponentAc.cpp.

◆ getTime()

Fw::Time Drv::StreamCrossoverComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 612 of file StreamCrossoverComponentAc.cpp.

◆ init()

void Drv::StreamCrossoverComponentBase::init ( FwEnumStoreType instance = 0 )

Initialize StreamCrossoverComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file StreamCrossoverComponentAc.cpp.

◆ isConnected_errorDeallocate_OutputPort()

bool Drv::StreamCrossoverComponentBase::isConnected_errorDeallocate_OutputPort ( FwIndexType portNum )

protected

Check whether port errorDeallocate is connected

Returns: Whether port errorDeallocate is connected

Parameters

portNum The port number

Definition at line 436 of file StreamCrossoverComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Drv::StreamCrossoverComponentBase::isConnected_logOut_OutputPort ( FwIndexType portNum )

protected

Check whether port logOut is connected

Returns: Whether port logOut is connected

Parameters

portNum The port number

Definition at line 395 of file StreamCrossoverComponentAc.cpp.

◆ isConnected_streamOut_OutputPort()

bool Drv::StreamCrossoverComponentBase::isConnected_streamOut_OutputPort ( FwIndexType portNum )

protected

Check whether port streamOut is connected

Returns: Whether port streamOut is connected

Parameters

portNum The port number

Definition at line 447 of file StreamCrossoverComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Drv::StreamCrossoverComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 421 of file StreamCrossoverComponentAc.cpp.

◆ log_WARNING_HI_StreamOutError()

void Drv::StreamCrossoverComponentBase::log_WARNING_HI_StreamOutError ( Drv::SendStatus sendStatus ) const

protected

Log event StreamOutError

Indicates buffer failed to send to streamOut.

Definition at line 523 of file StreamCrossoverComponentAc.cpp.

◆ set_errorDeallocate_OutputPort()

void Drv::StreamCrossoverComponentBase::set_errorDeallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to errorDeallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 218 of file StreamCrossoverComponentAc.cpp.

◆ set_logOut_OutputPort()

void Drv::StreamCrossoverComponentBase::set_logOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to logOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 168 of file StreamCrossoverComponentAc.cpp.

◆ set_streamOut_OutputPort()

void Drv::StreamCrossoverComponentBase::set_streamOut_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamSendPort *	port
	)

Connect port to streamOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 232 of file StreamCrossoverComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Drv::StreamCrossoverComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 200 of file StreamCrossoverComponentAc.cpp.

◆ streamIn_handler()

virtual void Drv::StreamCrossoverComponentBase::streamIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protectedpure virtual

Handler for input port streamIn.

Parameters

portNum The port number

◆ streamIn_handlerBase()

void Drv::StreamCrossoverComponentBase::streamIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protected

Handler base-class function for input port streamIn.

Parameters

portNum The port number

Definition at line 464 of file StreamCrossoverComponentAc.cpp.

◆ streamOut_out()

Drv::SendStatus Drv::StreamCrossoverComponentBase::streamOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protected

Invoke output port streamOut.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 504 of file StreamCrossoverComponentAc.cpp.

Friends And Related Function Documentation

◆ StreamCrossoverComponentBaseFriend

friend class StreamCrossoverComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 38 of file StreamCrossoverComponentAc.hpp.

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

Drv/StreamCrossover/StreamCrossoverComponentAc.hpp
Drv/StreamCrossover/StreamCrossoverComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ StreamCrossoverComponentBase()

◆ ~StreamCrossoverComponentBase()

Member Function Documentation

◆ errorDeallocate_out()

◆ get_streamIn_InputPort()

◆ getNum_errorDeallocate_OutputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_streamIn_InputPorts()

◆ getNum_streamOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_errorDeallocate_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_streamOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ log_WARNING_HI_StreamOutError()

◆ set_errorDeallocate_OutputPort()

◆ set_logOut_OutputPort()

◆ set_streamOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ streamIn_handler()

◆ streamIn_handlerBase()

◆ streamOut_out()

Friends And Related Function Documentation

◆ StreamCrossoverComponentBaseFriend