Svc::FprimeFramer Class Reference

#include <Svc/FprimeFramer/FprimeFramer.hpp>

Inheritance diagram for Svc::FprimeFramer:

Public Member Functions
	FprimeFramer (const char *const compName)
	Construct FprimeFramer object. More...
	~FprimeFramer ()
	Destroy FprimeFramer object. More...
Public Member Functions inherited from Svc::FprimeFramerComponentBase
void	init (FwEnumStoreType instance=0)
	Initialize FprimeFramerComponentBase object. More...
Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (FwIndexType portNum)
Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)
Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)
void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...
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_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
	Connect port to comStatusOut[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

Additional Inherited Members
Protected Types inherited from Svc::FprimeFramerComponentBase
enum	{ NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{ NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{   NUM_BUFFERALLOCATE_OUTPUT_PORTS = 1, NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, NUM_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1,   NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
Protected Member Functions inherited from Svc::FprimeFramerComponentBase
	FprimeFramerComponentBase (const char *compName="")
	Construct FprimeFramerComponentBase object. More...
virtual	~FprimeFramerComponentBase ()
	Destroy FprimeFramerComponentBase object. More...
bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)
bool	isConnected_bufferAllocate_OutputPort (FwIndexType portNum)
bool	isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)
bool	isConnected_comStatusOut_OutputPort (FwIndexType portNum)
bool	isConnected_dataOut_OutputPort (FwIndexType portNum)
bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)
void	comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn. 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...
Fw::Buffer	bufferAllocate_out (FwIndexType portNum, FwSizeType size)
	Invoke output port bufferAllocate. 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...
void	dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataOut. More...
void	dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataReturnOut. More...
Fw::Time	getTime () const
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 inherited from Svc::FprimeFramerComponentBase
static constexpr FwIndexType	getNum_comStatusIn_InputPorts ()
static constexpr FwIndexType	getNum_dataIn_InputPorts ()
static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()
static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()
static constexpr FwIndexType	getNum_bufferAllocate_OutputPorts ()
static constexpr FwIndexType	getNum_bufferDeallocate_OutputPorts ()
static constexpr FwIndexType	getNum_comStatusOut_OutputPorts ()
static constexpr FwIndexType	getNum_dataOut_OutputPorts ()
static constexpr FwIndexType	getNum_dataReturnOut_OutputPorts ()

Detailed Description

Definition at line 14 of file FprimeFramer.hpp.

Constructor & Destructor Documentation

FprimeFramer()

Svc::FprimeFramer::FprimeFramer

(

const char *const

compName

)

Construct FprimeFramer object.

Parameters

compName

The component name

Definition at line 18 of file FprimeFramer.cpp.

~FprimeFramer()

Svc::FprimeFramer::~FprimeFramer

(

)

Destroy FprimeFramer object.

Definition at line 20 of file FprimeFramer.cpp.

---

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

• Svc/FprimeFramer/FprimeFramer.hpp
• Svc/FprimeFramer/FprimeFramer.cpp