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

#include <Svc/Framer/FramerComponentAc.hpp>

Inheritance diagram for Svc::FramerComponentBase:

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

Fw::InputBufferSendPort *	get_bufferIn_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)

Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (FwIndexType portNum)

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

void	set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
	Connect port to comStatusOut[portNum]. More...

void	set_framedAllocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to framedAllocate[portNum]. More...

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

enum	{ NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_COMSTATUSOUT_OUTPUT_PORTS = 1 , NUM_FRAMEDALLOCATE_OUTPUT_PORTS = 1 , NUM_FRAMEDOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

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

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

FwIndexType	getNum_bufferIn_InputPorts () const

FwIndexType	getNum_comIn_InputPorts () const

FwIndexType	getNum_comStatusIn_InputPorts () const

FwIndexType	getNum_bufferDeallocate_OutputPorts () const

FwIndexType	getNum_comStatusOut_OutputPorts () const

FwIndexType	getNum_framedAllocate_OutputPorts () const

FwIndexType	getNum_framedOut_OutputPorts () const

bool	isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_comStatusOut_OutputPort (FwIndexType portNum)

bool	isConnected_framedAllocate_OutputPort (FwIndexType portNum)

bool	isConnected_framedOut_OutputPort (FwIndexType portNum)

virtual void	bufferIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferIn. More...

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

virtual void	comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0
	Handler for input port comStatusIn. More...

void	bufferIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferIn. More...

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

void	comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn. More...

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

void	comStatusOut_out (FwIndexType portNum, Fw::Success &condition)
	Invoke output port comStatusOut. More...

Fw::Buffer	framedAllocate_out (FwIndexType portNum, U32 size)
	Invoke output port framedAllocate. More...

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

virtual void	lock ()
	Lock the guarded mutex. More...

virtual void	unLock ()
	Unlock the guarded mutex. More...

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

Detailed Description

Auto-generated base for Framer component.

A component for framing input for transmission to the ground

Definition at line 27 of file FramerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERIN_INPUT_PORTS
NUM_COMIN_INPUT_PORTS
NUM_COMSTATUSIN_INPUT_PORTS

Definition at line 45 of file FramerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERDEALLOCATE_OUTPUT_PORTS
NUM_COMSTATUSOUT_OUTPUT_PORTS
NUM_FRAMEDALLOCATE_OUTPUT_PORTS
NUM_FRAMEDOUT_OUTPUT_PORTS

Definition at line 52 of file FramerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FramerComponentBase()

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

protected

Construct FramerComponentBase object.

Parameters

compName The component name

Definition at line 312 of file FramerComponentAc.cpp.

◆ ~FramerComponentBase()

Svc::FramerComponentBase::~FramerComponentBase ( )

protectedvirtual

Destroy FramerComponentBase object.

Definition at line 319 of file FramerComponentAc.cpp.

Member Function Documentation

◆ bufferDeallocate_out()

void Svc::FramerComponentBase::bufferDeallocate_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 504 of file FramerComponentAc.cpp.

◆ bufferIn_handler()

virtual void Svc::FramerComponentBase::bufferIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferIn_handlerBase()

void Svc::FramerComponentBase::bufferIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 429 of file FramerComponentAc.cpp.

◆ comIn_handler()

virtual void Svc::FramerComponentBase::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::FramerComponentBase::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 454 of file FramerComponentAc.cpp.

◆ comStatusIn_handler()

virtual void Svc::FramerComponentBase::comStatusIn_handler	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protectedpure virtual

Handler for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

◆ comStatusIn_handlerBase()

void Svc::FramerComponentBase::comStatusIn_handlerBase	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protected

Handler base-class function for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 481 of file FramerComponentAc.cpp.

◆ comStatusOut_out()

void Svc::FramerComponentBase::comStatusOut_out	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protected

Invoke output port comStatusOut.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 519 of file FramerComponentAc.cpp.

◆ framedAllocate_out()

Fw::Buffer Svc::FramerComponentBase::framedAllocate_out	(	FwIndexType	portNum,
		U32	size
	)

protected

Invoke output port framedAllocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 534 of file FramerComponentAc.cpp.

◆ framedOut_out()

Drv::SendStatus Svc::FramerComponentBase::framedOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protected

Invoke output port framedOut.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 549 of file FramerComponentAc.cpp.

◆ get_bufferIn_InputPort()

Fw::InputBufferSendPort * Svc::FramerComponentBase::get_bufferIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferIn[portNum]

Parameters

portNum The port number

Definition at line 179 of file FramerComponentAc.cpp.

◆ get_comIn_InputPort()

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

Get typed input port at index

Returns: comIn[portNum]

Parameters

portNum The port number

Definition at line 190 of file FramerComponentAc.cpp.

◆ get_comStatusIn_InputPort()

Fw::InputSuccessConditionPort * Svc::FramerComponentBase::get_comStatusIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comStatusIn[portNum]

Parameters

portNum The port number

Definition at line 201 of file FramerComponentAc.cpp.

◆ getNum_bufferDeallocate_OutputPorts()

FwIndexType Svc::FramerComponentBase::getNum_bufferDeallocate_OutputPorts ( ) const

protected

Get the number of bufferDeallocate output ports

Returns: The number of bufferDeallocate output ports

Definition at line 351 of file FramerComponentAc.cpp.

◆ getNum_bufferIn_InputPorts()

FwIndexType Svc::FramerComponentBase::getNum_bufferIn_InputPorts ( ) const

protected

Get the number of bufferIn input ports

Returns: The number of bufferIn input ports

Definition at line 329 of file FramerComponentAc.cpp.

◆ getNum_comIn_InputPorts()

FwIndexType Svc::FramerComponentBase::getNum_comIn_InputPorts ( ) const

protected

Get the number of comIn input ports

Returns: The number of comIn input ports

Definition at line 335 of file FramerComponentAc.cpp.

◆ getNum_comStatusIn_InputPorts()

FwIndexType Svc::FramerComponentBase::getNum_comStatusIn_InputPorts ( ) const

protected

Get the number of comStatusIn input ports

Returns: The number of comStatusIn input ports

Definition at line 341 of file FramerComponentAc.cpp.

◆ getNum_comStatusOut_OutputPorts()

FwIndexType Svc::FramerComponentBase::getNum_comStatusOut_OutputPorts ( ) const

protected

Get the number of comStatusOut output ports

Returns: The number of comStatusOut output ports

Definition at line 357 of file FramerComponentAc.cpp.

◆ getNum_framedAllocate_OutputPorts()

FwIndexType Svc::FramerComponentBase::getNum_framedAllocate_OutputPorts ( ) const

protected

Get the number of framedAllocate output ports

Returns: The number of framedAllocate output ports

Definition at line 363 of file FramerComponentAc.cpp.

◆ getNum_framedOut_OutputPorts()

FwIndexType Svc::FramerComponentBase::getNum_framedOut_OutputPorts ( ) const

protected

Get the number of framedOut output ports

Returns: The number of framedOut output ports

Definition at line 369 of file FramerComponentAc.cpp.

◆ init()

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

Initialize FramerComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file FramerComponentAc.cpp.

◆ isConnected_bufferDeallocate_OutputPort()

bool Svc::FramerComponentBase::isConnected_bufferDeallocate_OutputPort ( FwIndexType portNum )

protected

Check whether port bufferDeallocate is connected

Returns: Whether port bufferDeallocate is connected

Parameters

portNum The port number

Definition at line 379 of file FramerComponentAc.cpp.

◆ isConnected_comStatusOut_OutputPort()

bool Svc::FramerComponentBase::isConnected_comStatusOut_OutputPort ( FwIndexType portNum )

protected

Check whether port comStatusOut is connected

Returns: Whether port comStatusOut is connected

Parameters

portNum The port number

Definition at line 390 of file FramerComponentAc.cpp.

◆ isConnected_framedAllocate_OutputPort()

bool Svc::FramerComponentBase::isConnected_framedAllocate_OutputPort ( FwIndexType portNum )

protected

Check whether port framedAllocate is connected

Returns: Whether port framedAllocate is connected

Parameters

portNum The port number

Definition at line 401 of file FramerComponentAc.cpp.

◆ isConnected_framedOut_OutputPort()

bool Svc::FramerComponentBase::isConnected_framedOut_OutputPort ( FwIndexType portNum )

protected

Check whether port framedOut is connected

Returns: Whether port framedOut is connected

Parameters

portNum The port number

Definition at line 412 of file FramerComponentAc.cpp.

◆ lock()

void Svc::FramerComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 571 of file FramerComponentAc.cpp.

◆ set_bufferDeallocate_OutputPort()

void Svc::FramerComponentBase::set_bufferDeallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferDeallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 216 of file FramerComponentAc.cpp.

◆ set_comStatusOut_OutputPort()

void Svc::FramerComponentBase::set_comStatusOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputSuccessConditionPort *	port
	)

Connect port to comStatusOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 230 of file FramerComponentAc.cpp.

◆ set_framedAllocate_OutputPort()

void Svc::FramerComponentBase::set_framedAllocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to framedAllocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 244 of file FramerComponentAc.cpp.

◆ set_framedOut_OutputPort()

void Svc::FramerComponentBase::set_framedOut_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamSendPort *	port
	)

Connect port to framedOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 258 of file FramerComponentAc.cpp.

◆ unLock()

void Svc::FramerComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 577 of file FramerComponentAc.cpp.

Friends And Related Function Documentation

◆ FramerComponentBaseFriend

friend class FramerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 36 of file FramerComponentAc.hpp.

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

Svc/Framer/FramerComponentAc.hpp
Svc/Framer/FramerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FramerComponentBase()

◆ ~FramerComponentBase()

Member Function Documentation

◆ bufferDeallocate_out()

◆ bufferIn_handler()

◆ bufferIn_handlerBase()

◆ comIn_handler()

◆ comIn_handlerBase()

◆ comStatusIn_handler()

◆ comStatusIn_handlerBase()

◆ comStatusOut_out()

◆ framedAllocate_out()

◆ framedOut_out()

◆ get_bufferIn_InputPort()

◆ get_comIn_InputPort()

◆ get_comStatusIn_InputPort()

◆ getNum_bufferDeallocate_OutputPorts()

◆ getNum_bufferIn_InputPorts()

◆ getNum_comIn_InputPorts()

◆ getNum_comStatusIn_InputPorts()

◆ getNum_comStatusOut_OutputPorts()

◆ getNum_framedAllocate_OutputPorts()

◆ getNum_framedOut_OutputPorts()

◆ init()

◆ isConnected_bufferDeallocate_OutputPort()

◆ isConnected_comStatusOut_OutputPort()

◆ isConnected_framedAllocate_OutputPort()

◆ isConnected_framedOut_OutputPort()

◆ lock()

◆ set_bufferDeallocate_OutputPort()

◆ set_comStatusOut_OutputPort()

◆ set_framedAllocate_OutputPort()

◆ set_framedOut_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ FramerComponentBaseFriend