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...

Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_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_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataOut[portNum]. More...

void	set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataReturnOut[portNum]. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...

FwIdType	getIdBase () const

virtual void	deinit ()
	Deinitialization function. More...

Protected Types
enum	{ NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_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_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

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

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

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

bool	isConnected_logOut_OutputPort (FwIndexType portNum) const

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum) const

bool	isConnected_dataOut_OutputPort (FwIndexType portNum) const

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum) const

virtual void	dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
	Handler for input port dataIn. More...

virtual void	dataReturnIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
	Handler for input port dataReturnIn. More...

void	dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataIn. More...

void	dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataReturnIn. More...

void	dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const
	Invoke output port dataOut. More...

void	dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const
	Invoke output port dataReturnOut. 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

void	log_WARNING_LO_PayloadTooShort () const

Fw::Time	getTime () const

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...

Static Protected Member Functions
static constexpr FwIndexType	getNum_dataIn_InputPorts ()

static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()

static constexpr FwIndexType	getNum_logOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_dataOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataReturnOut_OutputPorts ()

Friends
class	FprimeDeframerTesterBase
	Friend class tester to support autocoded test harness. More...

class	FprimeDeframerTester
	Friend class tester implementation to support 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 36 of file FprimeDeframerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_DATAIN_INPUT_PORTS
NUM_DATARETURNIN_INPUT_PORTS

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

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_DATAOUT_OUTPUT_PORTS
NUM_DATARETURNOUT_OUTPUT_PORTS

Definition at line 69 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)
EVENTID_PAYLOADTOOSHORT	An invalid frame was received (not enough data to contain a valid FwPacketDescriptor type)

Definition at line 75 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 399 of file FprimeDeframerComponentAc.cpp.

◆ ~FprimeDeframerComponentBase()

Svc::FprimeDeframerComponentBase::~FprimeDeframerComponentBase ( )

protectedvirtual

Destroy FprimeDeframerComponentBase object.

Definition at line 406 of file FprimeDeframerComponentAc.cpp.

Member Function Documentation

◆ dataIn_handler()

virtual void Svc::FprimeDeframerComponentBase::dataIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protectedpure virtual

Handler for input port dataIn.

Parameters

portNum The port number

◆ dataIn_handlerBase()

void Svc::FprimeDeframerComponentBase::dataIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protected

Handler base-class function for input port dataIn.

Parameters

portNum The port number

Definition at line 493 of file FprimeDeframerComponentAc.cpp.

◆ dataOut_out()

void Svc::FprimeDeframerComponentBase::dataOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)		const

protected

Invoke output port dataOut.

Parameters

portNum The port number

Definition at line 547 of file FprimeDeframerComponentAc.cpp.

◆ dataReturnIn_handler()

virtual void Svc::FprimeDeframerComponentBase::dataReturnIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protectedpure virtual

Handler for input port dataReturnIn.

Parameters

portNum The port number

◆ dataReturnIn_handlerBase()

void Svc::FprimeDeframerComponentBase::dataReturnIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protected

Handler base-class function for input port dataReturnIn.

Parameters

portNum The port number

Definition at line 520 of file FprimeDeframerComponentAc.cpp.

◆ dataReturnOut_out()

void Svc::FprimeDeframerComponentBase::dataReturnOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)		const

protected

Invoke output port dataReturnOut.

Parameters

portNum The port number

Definition at line 569 of file FprimeDeframerComponentAc.cpp.

◆ get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::FprimeDeframerComponentBase::get_dataIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: dataIn[portNum]

Parameters

portNum The port number

Definition at line 191 of file FprimeDeframerComponentAc.cpp.

◆ get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::FprimeDeframerComponentBase::get_dataReturnIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: dataReturnIn[portNum]

Parameters

portNum The port number

Definition at line 202 of file FprimeDeframerComponentAc.cpp.

◆ getNum_dataIn_InputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_dataIn_InputPorts ( )

inlinestaticprotected

Get the number of dataIn input ports

Returns: The number of dataIn input ports

Definition at line 249 of file FprimeDeframerComponentAc.hpp.

◆ getNum_dataOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_dataOut_OutputPorts ( )

inlinestaticprotected

Get the number of dataOut output ports

Returns: The number of dataOut output ports

Definition at line 300 of file FprimeDeframerComponentAc.hpp.

◆ getNum_dataReturnIn_InputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_dataReturnIn_InputPorts ( )

inlinestaticprotected

Get the number of dataReturnIn input ports

Returns: The number of dataReturnIn input ports

Definition at line 256 of file FprimeDeframerComponentAc.hpp.

◆ getNum_dataReturnOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_dataReturnOut_OutputPorts ( )

inlinestaticprotected

Get the number of dataReturnOut output ports

Returns: The number of dataReturnOut output ports

Definition at line 307 of file FprimeDeframerComponentAc.hpp.

◆ getNum_logOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_logOut_OutputPorts ( )

inlinestaticprotected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 269 of file FprimeDeframerComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::FprimeDeframerComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 287 of file FprimeDeframerComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 926 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_dataOut_OutputPort()

bool Svc::FprimeDeframerComponentBase::isConnected_dataOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port dataOut is connected

Returns: Whether port dataOut is connected

Parameters

portNum The port number

Definition at line 463 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_dataReturnOut_OutputPort()

bool Svc::FprimeDeframerComponentBase::isConnected_dataReturnOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port dataReturnOut is connected

Returns: Whether port dataReturnOut is connected

Parameters

portNum The port number

Definition at line 474 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::FprimeDeframerComponentBase::isConnected_logOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port logOut is connected

Returns: Whether port logOut is connected

Parameters

portNum The port number

Definition at line 418 of file FprimeDeframerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FprimeDeframerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum ) const

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 444 of file FprimeDeframerComponentAc.cpp.

◆ lock()

void Svc::FprimeDeframerComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 946 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 597 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 792 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 727 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 662 of file FprimeDeframerComponentAc.cpp.

◆ log_WARNING_LO_PayloadTooShort()

void Svc::FprimeDeframerComponentBase::log_WARNING_LO_PayloadTooShort ( ) const

protected

Log event PayloadTooShort

An invalid frame was received (not enough data to contain a valid FwPacketDescriptor type)

Definition at line 857 of file FprimeDeframerComponentAc.cpp.

◆ set_dataOut_OutputPort()

void Svc::FprimeDeframerComponentBase::set_dataOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputComDataWithContextPort *	port
	)

Connect port to dataOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 275 of file FprimeDeframerComponentAc.cpp.

◆ set_dataReturnOut_OutputPort()

void Svc::FprimeDeframerComponentBase::set_dataReturnOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputComDataWithContextPort *	port
	)

Connect port to dataReturnOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 289 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 221 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 253 of file FprimeDeframerComponentAc.cpp.

◆ unLock()

void Svc::FprimeDeframerComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 952 of file FprimeDeframerComponentAc.cpp.

Friends And Related Function Documentation

◆ FprimeDeframerTester

friend class FprimeDeframerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 47 of file FprimeDeframerComponentAc.hpp.

◆ FprimeDeframerTesterBase

friend class FprimeDeframerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 45 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

Static 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

◆ dataIn_handler()

◆ dataIn_handlerBase()

◆ dataOut_out()

◆ dataReturnIn_handler()

◆ dataReturnIn_handlerBase()

◆ dataReturnOut_out()

◆ get_dataIn_InputPort()

◆ get_dataReturnIn_InputPort()

◆ getNum_dataIn_InputPorts()

◆ getNum_dataOut_OutputPorts()

◆ getNum_dataReturnIn_InputPorts()

◆ getNum_dataReturnOut_OutputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_dataOut_OutputPort()

◆ isConnected_dataReturnOut_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ lock()

◆ log_WARNING_HI_InvalidBufferReceived()

◆ log_WARNING_HI_InvalidChecksum()

◆ log_WARNING_HI_InvalidLengthReceived()

◆ log_WARNING_HI_InvalidStartWord()

◆ log_WARNING_LO_PayloadTooShort()

◆ set_dataOut_OutputPort()

◆ set_dataReturnOut_OutputPort()

◆ set_logOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ FprimeDeframerTester

◆ FprimeDeframerTesterBase