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

#include <Svc/Deframer/DeframerComponentAc.hpp>

Inheritance diagram for Svc::DeframerComponentBase:

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

Fw::InputCmdResponsePort *	get_cmdResponseIn_InputPort (FwIndexType portNum)

Drv::InputByteStreamRecvPort *	get_framedIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)

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

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

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

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

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

void	set_framedPoll_OutputPort (FwIndexType portNum, Drv::InputByteStreamPollPort *port)
	Connect port to framedPoll[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_CMDRESPONSEIN_INPUT_PORTS = 1 , NUM_FRAMEDIN_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_BUFFERALLOCATE_OUTPUT_PORTS = 1 , NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_BUFFEROUT_OUTPUT_PORTS = 1 , NUM_COMOUT_OUTPUT_PORTS = 1 , NUM_FRAMEDDEALLOCATE_OUTPUT_PORTS = 1 , NUM_FRAMEDPOLL_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

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

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

FwIndexType	getNum_cmdResponseIn_InputPorts () const

FwIndexType	getNum_framedIn_InputPorts () const

FwIndexType	getNum_schedIn_InputPorts () const

FwIndexType	getNum_bufferAllocate_OutputPorts () const

FwIndexType	getNum_bufferDeallocate_OutputPorts () const

FwIndexType	getNum_bufferOut_OutputPorts () const

FwIndexType	getNum_comOut_OutputPorts () const

FwIndexType	getNum_framedDeallocate_OutputPorts () const

FwIndexType	getNum_framedPoll_OutputPorts () const

bool	isConnected_bufferAllocate_OutputPort (FwIndexType portNum)

bool	isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_bufferOut_OutputPort (FwIndexType portNum)

bool	isConnected_comOut_OutputPort (FwIndexType portNum)

bool	isConnected_framedDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_framedPoll_OutputPort (FwIndexType portNum)

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

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

virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn. More...

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

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

void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn. More...

Fw::Buffer	bufferAllocate_out (FwIndexType portNum, U32 size)
	Invoke output port bufferAllocate. More...

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

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

void	comOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port comOut. More...

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

Drv::PollStatus	framedPoll_out (FwIndexType portNum, Fw::Buffer &pollBuffer)
	Invoke output port framedPoll. 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	DeframerComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for Deframer component.

A component for deframing input received from the ground via a byte stream driver, which may be active or passive

Definition at line 30 of file DeframerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CMDRESPONSEIN_INPUT_PORTS
NUM_FRAMEDIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 48 of file DeframerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERALLOCATE_OUTPUT_PORTS
NUM_BUFFERDEALLOCATE_OUTPUT_PORTS
NUM_BUFFEROUT_OUTPUT_PORTS
NUM_COMOUT_OUTPUT_PORTS
NUM_FRAMEDDEALLOCATE_OUTPUT_PORTS
NUM_FRAMEDPOLL_OUTPUT_PORTS

Definition at line 55 of file DeframerComponentAc.hpp.

Constructor & Destructor Documentation

◆ DeframerComponentBase()

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

protected

Construct DeframerComponentBase object.

Parameters

compName The component name

Definition at line 406 of file DeframerComponentAc.cpp.

◆ ~DeframerComponentBase()

Svc::DeframerComponentBase::~DeframerComponentBase ( )

protectedvirtual

Destroy DeframerComponentBase object.

Definition at line 413 of file DeframerComponentAc.cpp.

Member Function Documentation

◆ bufferAllocate_out()

Fw::Buffer Svc::DeframerComponentBase::bufferAllocate_out	(	FwIndexType	portNum,
		U32	size
	)

protected

Invoke output port bufferAllocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 636 of file DeframerComponentAc.cpp.

◆ bufferDeallocate_out()

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

protected

Invoke output port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 651 of file DeframerComponentAc.cpp.

◆ bufferOut_out()

void Svc::DeframerComponentBase::bufferOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port bufferOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 666 of file DeframerComponentAc.cpp.

◆ cmdResponseIn_handler()

virtual void Svc::DeframerComponentBase::cmdResponseIn_handler	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protectedpure virtual

Handler for input port cmdResponseIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

◆ cmdResponseIn_handlerBase()

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

protected

Handler base-class function for input port cmdResponseIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 557 of file DeframerComponentAc.cpp.

◆ comOut_out()

void Svc::DeframerComponentBase::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 681 of file DeframerComponentAc.cpp.

◆ framedDeallocate_out()

void Svc::DeframerComponentBase::framedDeallocate_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port framedDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 698 of file DeframerComponentAc.cpp.

◆ framedIn_handler()

virtual void Svc::DeframerComponentBase::framedIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protectedpure virtual

Handler for input port framedIn.

Parameters

portNum The port number

◆ framedIn_handlerBase()

void Svc::DeframerComponentBase::framedIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protected

Handler base-class function for input port framedIn.

Parameters

portNum The port number

Definition at line 580 of file DeframerComponentAc.cpp.

◆ framedPoll_out()

Drv::PollStatus Svc::DeframerComponentBase::framedPoll_out	(	FwIndexType	portNum,
		Fw::Buffer &	pollBuffer
	)

protected

Invoke output port framedPoll.

Parameters

portNum The port number

Definition at line 713 of file DeframerComponentAc.cpp.

◆ get_cmdResponseIn_InputPort()

Fw::InputCmdResponsePort * Svc::DeframerComponentBase::get_cmdResponseIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: cmdResponseIn[portNum]

Parameters

portNum The port number

Definition at line 217 of file DeframerComponentAc.cpp.

◆ get_framedIn_InputPort()

Drv::InputByteStreamRecvPort * Svc::DeframerComponentBase::get_framedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: framedIn[portNum]

Parameters

portNum The port number

Definition at line 228 of file DeframerComponentAc.cpp.

◆ get_schedIn_InputPort()

Svc::InputSchedPort * Svc::DeframerComponentBase::get_schedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: schedIn[portNum]

Parameters

portNum The port number

Definition at line 239 of file DeframerComponentAc.cpp.

◆ getNum_bufferAllocate_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_bufferAllocate_OutputPorts ( ) const

protected

Get the number of bufferAllocate output ports

Returns: The number of bufferAllocate output ports

Definition at line 445 of file DeframerComponentAc.cpp.

◆ getNum_bufferDeallocate_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_bufferDeallocate_OutputPorts ( ) const

protected

Get the number of bufferDeallocate output ports

Returns: The number of bufferDeallocate output ports

Definition at line 451 of file DeframerComponentAc.cpp.

◆ getNum_bufferOut_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_bufferOut_OutputPorts ( ) const

protected

Get the number of bufferOut output ports

Returns: The number of bufferOut output ports

Definition at line 457 of file DeframerComponentAc.cpp.

◆ getNum_cmdResponseIn_InputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_cmdResponseIn_InputPorts ( ) const

protected

Get the number of cmdResponseIn input ports

Returns: The number of cmdResponseIn input ports

Definition at line 423 of file DeframerComponentAc.cpp.

◆ getNum_comOut_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_comOut_OutputPorts ( ) const

protected

Get the number of comOut output ports

Returns: The number of comOut output ports

Definition at line 463 of file DeframerComponentAc.cpp.

◆ getNum_framedDeallocate_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_framedDeallocate_OutputPorts ( ) const

protected

Get the number of framedDeallocate output ports

Returns: The number of framedDeallocate output ports

Definition at line 469 of file DeframerComponentAc.cpp.

◆ getNum_framedIn_InputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_framedIn_InputPorts ( ) const

protected

Get the number of framedIn input ports

Returns: The number of framedIn input ports

Definition at line 429 of file DeframerComponentAc.cpp.

◆ getNum_framedPoll_OutputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_framedPoll_OutputPorts ( ) const

protected

Get the number of framedPoll output ports

Returns: The number of framedPoll output ports

Definition at line 475 of file DeframerComponentAc.cpp.

◆ getNum_schedIn_InputPorts()

FwIndexType Svc::DeframerComponentBase::getNum_schedIn_InputPorts ( ) const

protected

Get the number of schedIn input ports

Returns: The number of schedIn input ports

Definition at line 435 of file DeframerComponentAc.cpp.

◆ init()

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

Initialize DeframerComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file DeframerComponentAc.cpp.

◆ isConnected_bufferAllocate_OutputPort()

bool Svc::DeframerComponentBase::isConnected_bufferAllocate_OutputPort ( FwIndexType portNum )

protected

Check whether port bufferAllocate is connected

Returns: Whether port bufferAllocate is connected

Parameters

portNum The port number

Definition at line 485 of file DeframerComponentAc.cpp.

◆ isConnected_bufferDeallocate_OutputPort()

bool Svc::DeframerComponentBase::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 496 of file DeframerComponentAc.cpp.

◆ isConnected_bufferOut_OutputPort()

bool Svc::DeframerComponentBase::isConnected_bufferOut_OutputPort ( FwIndexType portNum )

protected

Check whether port bufferOut is connected

Returns: Whether port bufferOut is connected

Parameters

portNum The port number

Definition at line 507 of file DeframerComponentAc.cpp.

◆ isConnected_comOut_OutputPort()

bool Svc::DeframerComponentBase::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 518 of file DeframerComponentAc.cpp.

◆ isConnected_framedDeallocate_OutputPort()

bool Svc::DeframerComponentBase::isConnected_framedDeallocate_OutputPort ( FwIndexType portNum )

protected

Check whether port framedDeallocate is connected

Returns: Whether port framedDeallocate is connected

Parameters

portNum The port number

Definition at line 529 of file DeframerComponentAc.cpp.

◆ isConnected_framedPoll_OutputPort()

bool Svc::DeframerComponentBase::isConnected_framedPoll_OutputPort ( FwIndexType portNum )

protected

Check whether port framedPoll is connected

Returns: Whether port framedPoll is connected

Parameters

portNum The port number

Definition at line 540 of file DeframerComponentAc.cpp.

◆ lock()

void Svc::DeframerComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 735 of file DeframerComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::DeframerComponentBase::schedIn_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

◆ schedIn_handlerBase()

void Svc::DeframerComponentBase::schedIn_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 607 of file DeframerComponentAc.cpp.

◆ set_bufferAllocate_OutputPort()

void Svc::DeframerComponentBase::set_bufferAllocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to bufferAllocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 254 of file DeframerComponentAc.cpp.

◆ set_bufferDeallocate_OutputPort()

void Svc::DeframerComponentBase::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 268 of file DeframerComponentAc.cpp.

◆ set_bufferOut_OutputPort()

void Svc::DeframerComponentBase::set_bufferOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 282 of file DeframerComponentAc.cpp.

◆ set_comOut_OutputPort()

void Svc::DeframerComponentBase::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 296 of file DeframerComponentAc.cpp.

◆ set_framedDeallocate_OutputPort()

void Svc::DeframerComponentBase::set_framedDeallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to framedDeallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 310 of file DeframerComponentAc.cpp.

◆ set_framedPoll_OutputPort()

void Svc::DeframerComponentBase::set_framedPoll_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamPollPort *	port
	)

Connect port to framedPoll[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 324 of file DeframerComponentAc.cpp.

◆ unLock()

void Svc::DeframerComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 741 of file DeframerComponentAc.cpp.

Friends And Related Function Documentation

◆ DeframerComponentBaseFriend

friend class DeframerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 39 of file DeframerComponentAc.hpp.

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

Svc/Deframer/DeframerComponentAc.hpp
Svc/Deframer/DeframerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ DeframerComponentBase()

◆ ~DeframerComponentBase()

Member Function Documentation

◆ bufferAllocate_out()

◆ bufferDeallocate_out()

◆ bufferOut_out()

◆ cmdResponseIn_handler()

◆ cmdResponseIn_handlerBase()

◆ comOut_out()

◆ framedDeallocate_out()

◆ framedIn_handler()

◆ framedIn_handlerBase()

◆ framedPoll_out()

◆ get_cmdResponseIn_InputPort()

◆ get_framedIn_InputPort()

◆ get_schedIn_InputPort()

◆ getNum_bufferAllocate_OutputPorts()

◆ getNum_bufferDeallocate_OutputPorts()

◆ getNum_bufferOut_OutputPorts()

◆ getNum_cmdResponseIn_InputPorts()

◆ getNum_comOut_OutputPorts()

◆ getNum_framedDeallocate_OutputPorts()

◆ getNum_framedIn_InputPorts()

◆ getNum_framedPoll_OutputPorts()

◆ getNum_schedIn_InputPorts()

◆ init()

◆ isConnected_bufferAllocate_OutputPort()

◆ isConnected_bufferDeallocate_OutputPort()

◆ isConnected_bufferOut_OutputPort()

◆ isConnected_comOut_OutputPort()

◆ isConnected_framedDeallocate_OutputPort()

◆ isConnected_framedPoll_OutputPort()

◆ lock()

◆ schedIn_handler()

◆ schedIn_handlerBase()

◆ set_bufferAllocate_OutputPort()

◆ set_bufferDeallocate_OutputPort()

◆ set_bufferOut_OutputPort()

◆ set_comOut_OutputPort()

◆ set_framedDeallocate_OutputPort()

◆ set_framedPoll_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ DeframerComponentBaseFriend