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

#include <Svc/FprimeDeframer/FprimeDeframerComponentAc.hpp>

Inheritance diagram for Svc::FprimeDeframerComponentBase:

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

Fw::InputDataWithContextPort *	get_framedIn_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_bufferDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferDeallocate[portNum]. More...

void	set_deframedOut_OutputPort (FwIndexType portNum, Fw::InputDataWithContextPort *port)
	Connect port to deframedOut[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_FRAMEDIN_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_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, NUM_DEFRAMEDOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_INVALIDBUFFERRECEIVED = 0x0, EVENTID_INVALIDSTARTWORD = 0x1, EVENTID_INVALIDLENGTHRECEIVED = 0x2, EVENTID_INVALIDCHECKSUM = 0x3 }
	Event IDs. More...

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

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

FwIndexType	getNum_framedIn_InputPorts () const

FwIndexType	getNum_logOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_bufferDeallocate_OutputPorts () const

FwIndexType	getNum_deframedOut_OutputPorts () const

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_deframedOut_OutputPort (FwIndexType portNum)

virtual void	framedIn_handler (FwIndexType portNum, Fw::Buffer &data, Fw::Buffer &context)=0
	Handler for input port framedIn. More...

void	framedIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, Fw::Buffer &context)
	Handler base-class function for input port framedIn. More...

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

void	deframedOut_out (FwIndexType portNum, Fw::Buffer &data, Fw::Buffer &context)
	Invoke output port deframedOut. More...

void	log_WARNING_HI_InvalidBufferReceived () const

void	log_WARNING_HI_InvalidStartWord () const

void	log_WARNING_HI_InvalidLengthReceived () const

void	log_WARNING_HI_InvalidChecksum () const

Fw::Time	getTime ()

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

Detailed Description

Auto-generated base for FprimeDeframer component.

A component for deframing input received from the ground via a FrameAccumulator

Definition at line 31 of file FprimeDeframerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_FRAMEDIN_INPUT_PORTS

Definition at line 49 of file FprimeDeframerComponentAc.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 54 of file FprimeDeframerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERDEALLOCATE_OUTPUT_PORTS
NUM_DEFRAMEDOUT_OUTPUT_PORTS

Definition at line 61 of file FprimeDeframerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_INVALIDBUFFERRECEIVED	An invalid frame was received (too short to be a frame)
EVENTID_INVALIDSTARTWORD	An invalid frame was received (start word is wrong)
EVENTID_INVALIDLENGTHRECEIVED	An invalid frame was received (length is wrong)
EVENTID_INVALIDCHECKSUM	An invalid frame was received (checksum mismatch)

Definition at line 67 of file FprimeDeframerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FprimeDeframerComponentBase()

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

protected

Construct FprimeDeframerComponentBase object.

Parameters

compName The component name

Definition at line 340 of file FprimeDeframerComponentAc.cpp.

◆ ~FprimeDeframerComponentBase()

Svc::FprimeDeframerComponentBase::~FprimeDeframerComponentBase ( )

protectedvirtual

Destroy FprimeDeframerComponentBase object.

Definition at line 347 of file FprimeDeframerComponentAc.cpp.

Member Function Documentation

◆ bufferDeallocate_out()

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

protected

Invoke output port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 509 of file FprimeDeframerComponentAc.cpp.

◆ deframedOut_out()

void Svc::FprimeDeframerComponentBase::deframedOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		Fw::Buffer &	context
	)

protected

Invoke output port deframedOut.

Parameters

portNum The port number

Definition at line 529 of file FprimeDeframerComponentAc.cpp.

◆ framedIn_handler()

virtual void Svc::FprimeDeframerComponentBase::framedIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		Fw::Buffer &	context
	)

protectedpure virtual

Handler for input port framedIn.

Parameters

portNum The port number

◆ framedIn_handlerBase()

void Svc::FprimeDeframerComponentBase::framedIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		Fw::Buffer &	context
	)

protected

Handler base-class function for input port framedIn.

Parameters

portNum The port number

Definition at line 478 of file FprimeDeframerComponentAc.cpp.

◆ get_framedIn_InputPort()

Fw::InputDataWithContextPort * Svc::FprimeDeframerComponentBase::get_framedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: framedIn[portNum]

Parameters

portNum The port number

Definition at line 153 of file FprimeDeframerComponentAc.cpp.

◆ getNum_bufferDeallocate_OutputPorts()

FwIndexType Svc::FprimeDeframerComponentBase::getNum_bufferDeallocate_OutputPorts ( ) const

protected

Get the number of bufferDeallocate output ports

Returns: The number of bufferDeallocate output ports

Definition at line 393 of file FprimeDeframerComponentAc.cpp.

◆ getNum_deframedOut_OutputPorts()

FwIndexType Svc::FprimeDeframerComponentBase::getNum_deframedOut_OutputPorts ( ) const

protected

Get the number of deframedOut output ports

Returns: The number of deframedOut output ports

Definition at line 399 of file FprimeDeframerComponentAc.cpp.

◆ getNum_framedIn_InputPorts()

FwIndexType Svc::FprimeDeframerComponentBase::getNum_framedIn_InputPorts ( ) const

protected

Get the number of framedIn input ports

Returns: The number of framedIn input ports

Definition at line 357 of file FprimeDeframerComponentAc.cpp.

◆ getNum_logOut_OutputPorts()

FwIndexType Svc::FprimeDeframerComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 367 of file FprimeDeframerComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::FprimeDeframerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 383 of file FprimeDeframerComponentAc.cpp.

◆ getTime()

Fw::Time Svc::FprimeDeframerComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 819 of file FprimeDeframerComponentAc.cpp.

◆ init()

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

Initialize FprimeDeframerComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_bufferDeallocate_OutputPort()

bool Svc::FprimeDeframerComponentBase::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 450 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_deframedOut_OutputPort()

bool Svc::FprimeDeframerComponentBase::isConnected_deframedOut_OutputPort ( FwIndexType portNum )

protected

Check whether port deframedOut is connected

Returns: Whether port deframedOut is connected

Parameters

portNum The port number

Definition at line 461 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::FprimeDeframerComponentBase::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 409 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FprimeDeframerComponentBase::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 435 of file FprimeDeframerComponentAc.cpp.

◆ lock()

void Svc::FprimeDeframerComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 839 of file FprimeDeframerComponentAc.cpp.

◆ log_WARNING_HI_InvalidBufferReceived()

void Svc::FprimeDeframerComponentBase::log_WARNING_HI_InvalidBufferReceived ( ) const

protected

Log event InvalidBufferReceived

An invalid frame was received (too short to be a frame)

Definition at line 555 of file FprimeDeframerComponentAc.cpp.

◆ log_WARNING_HI_InvalidChecksum()

void Svc::FprimeDeframerComponentBase::log_WARNING_HI_InvalidChecksum ( ) const

protected

Log event InvalidChecksum

An invalid frame was received (checksum mismatch)

Definition at line 750 of file FprimeDeframerComponentAc.cpp.

◆ log_WARNING_HI_InvalidLengthReceived()

void Svc::FprimeDeframerComponentBase::log_WARNING_HI_InvalidLengthReceived ( ) const

protected

Log event InvalidLengthReceived

An invalid frame was received (length is wrong)

Definition at line 685 of file FprimeDeframerComponentAc.cpp.

◆ log_WARNING_HI_InvalidStartWord()

void Svc::FprimeDeframerComponentBase::log_WARNING_HI_InvalidStartWord ( ) const

protected

Log event InvalidStartWord

An invalid frame was received (start word is wrong)

Definition at line 620 of file FprimeDeframerComponentAc.cpp.

◆ set_bufferDeallocate_OutputPort()

void Svc::FprimeDeframerComponentBase::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 218 of file FprimeDeframerComponentAc.cpp.

◆ set_deframedOut_OutputPort()

void Svc::FprimeDeframerComponentBase::set_deframedOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputDataWithContextPort *	port
	)

Connect port to deframedOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 232 of file FprimeDeframerComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::FprimeDeframerComponentBase::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 FprimeDeframerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::FprimeDeframerComponentBase::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 FprimeDeframerComponentAc.cpp.

◆ unLock()

void Svc::FprimeDeframerComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 845 of file FprimeDeframerComponentAc.cpp.

Friends And Related Function Documentation

◆ FprimeDeframerComponentBaseFriend

friend class FprimeDeframerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 40 of file FprimeDeframerComponentAc.hpp.

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

Svc/FprimeDeframer/FprimeDeframerComponentAc.hpp
Svc/FprimeDeframer/FprimeDeframerComponentAc.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

◆ FprimeDeframerComponentBase()

◆ ~FprimeDeframerComponentBase()

Member Function Documentation

◆ bufferDeallocate_out()

◆ deframedOut_out()

◆ framedIn_handler()

◆ framedIn_handlerBase()

◆ get_framedIn_InputPort()

◆ getNum_bufferDeallocate_OutputPorts()

◆ getNum_deframedOut_OutputPorts()

◆ getNum_framedIn_InputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_bufferDeallocate_OutputPort()

◆ isConnected_deframedOut_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ lock()

◆ log_WARNING_HI_InvalidBufferReceived()

◆ log_WARNING_HI_InvalidChecksum()

◆ log_WARNING_HI_InvalidLengthReceived()

◆ log_WARNING_HI_InvalidStartWord()

◆ set_bufferDeallocate_OutputPort()

◆ set_deframedOut_OutputPort()

◆ set_logOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ FprimeDeframerComponentBaseFriend