Svc::FprimeFramerComponentBase Class Reference

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

#include <Svc/FprimeFramer/FprimeFramerComponentAc.hpp>

Inheritance diagram for Svc::FprimeFramerComponentBase:

Public Member Functions
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

Protected Types
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
	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)
virtual void	comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0
	Handler for input port comStatusIn. More...
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	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
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 ()

Friends
class	FprimeFramerTesterBase
	Friend class tester to support autocoded test harness. More...
class	FprimeFramerTester
	Friend class tester implementation to support white-box testing. More...

Detailed Description

Auto-generated base for FprimeFramer component.

Framer implementation for the F Prime protocol

Definition at line 26 of file FprimeFramerComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMSTATUSIN_INPUT_PORTS
NUM_DATAIN_INPUT_PORTS
NUM_DATARETURNIN_INPUT_PORTS

Definition at line 46 of file FprimeFramerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_TIMECALLER_OUTPUT_PORTS

Definition at line 53 of file FprimeFramerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERALLOCATE_OUTPUT_PORTS
NUM_BUFFERDEALLOCATE_OUTPUT_PORTS
NUM_COMSTATUSOUT_OUTPUT_PORTS
NUM_DATAOUT_OUTPUT_PORTS
NUM_DATARETURNOUT_OUTPUT_PORTS

Definition at line 58 of file FprimeFramerComponentAc.hpp.

Constructor & Destructor Documentation

FprimeFramerComponentBase()

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

protected

Construct FprimeFramerComponentBase object.

Parameters

compName

The component name

Definition at line 433 of file FprimeFramerComponentAc.cpp.

~FprimeFramerComponentBase()

Svc::FprimeFramerComponentBase::~FprimeFramerComponentBase ( )

protectedvirtual

Destroy FprimeFramerComponentBase object.

Definition at line 440 of file FprimeFramerComponentAc.cpp.

Member Function Documentation

bufferAllocate_out()

Fw::Buffer Svc::FprimeFramerComponentBase::bufferAllocate_out ( FwIndexType  portNum, FwSizeType  size  )

protected

Invoke output port bufferAllocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 591 of file FprimeFramerComponentAc.cpp.

bufferDeallocate_out()

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

protected

Invoke output port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 611 of file FprimeFramerComponentAc.cpp.

comStatusIn_handler()

virtual void Svc::FprimeFramerComponentBase::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::FprimeFramerComponentBase::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 526 of file FprimeFramerComponentAc.cpp.

comStatusOut_out()

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

protected

Invoke output port comStatusOut.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 631 of file FprimeFramerComponentAc.cpp.

dataIn_handler()

virtual void Svc::FprimeFramerComponentBase::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::FprimeFramerComponentBase::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 545 of file FprimeFramerComponentAc.cpp.

dataOut_out()

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

protected

Invoke output port dataOut.

Parameters

portNum

The port number

Definition at line 651 of file FprimeFramerComponentAc.cpp.

dataReturnIn_handler()

virtual void Svc::FprimeFramerComponentBase::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::FprimeFramerComponentBase::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 566 of file FprimeFramerComponentAc.cpp.

dataReturnOut_out()

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

protected

Invoke output port dataReturnOut.

Parameters

portNum

The port number

Definition at line 673 of file FprimeFramerComponentAc.cpp.

get_comStatusIn_InputPort()

Fw::InputSuccessConditionPort * Svc::FprimeFramerComponentBase::get_comStatusIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

comStatusIn[portNum]

Parameters

portNum

The port number

Definition at line 218 of file FprimeFramerComponentAc.cpp.

get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::FprimeFramerComponentBase::get_dataIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

dataIn[portNum]

Parameters

portNum

The port number

Definition at line 229 of file FprimeFramerComponentAc.cpp.

get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::FprimeFramerComponentBase::get_dataReturnIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

dataReturnIn[portNum]

Parameters

portNum

The port number

Definition at line 240 of file FprimeFramerComponentAc.cpp.

getNum_bufferAllocate_OutputPorts()

static constexpr FwIndexType Svc::FprimeFramerComponentBase::getNum_bufferAllocate_OutputPorts ( )

inlinestaticprotected

Get the number of bufferAllocate output ports

Returns

The number of bufferAllocate output ports

Definition at line 265 of file FprimeFramerComponentAc.hpp.

getNum_bufferDeallocate_OutputPorts()

static constexpr FwIndexType Svc::FprimeFramerComponentBase::getNum_bufferDeallocate_OutputPorts ( )

inlinestaticprotected

Get the number of bufferDeallocate output ports

Returns

The number of bufferDeallocate output ports

Definition at line 272 of file FprimeFramerComponentAc.hpp.

getNum_comStatusIn_InputPorts()

static constexpr FwIndexType Svc::FprimeFramerComponentBase::getNum_comStatusIn_InputPorts ( )

inlinestaticprotected

Get the number of comStatusIn input ports

Returns

The number of comStatusIn input ports

Definition at line 225 of file FprimeFramerComponentAc.hpp.

getNum_comStatusOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeFramerComponentBase::getNum_comStatusOut_OutputPorts ( )

inlinestaticprotected

Get the number of comStatusOut output ports

Returns

The number of comStatusOut output ports

Definition at line 279 of file FprimeFramerComponentAc.hpp.

getNum_dataIn_InputPorts()

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

inlinestaticprotected

Get the number of dataIn input ports

Returns

The number of dataIn input ports

Definition at line 232 of file FprimeFramerComponentAc.hpp.

getNum_dataOut_OutputPorts()

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

inlinestaticprotected

Get the number of dataOut output ports

Returns

The number of dataOut output ports

Definition at line 286 of file FprimeFramerComponentAc.hpp.

getNum_dataReturnIn_InputPorts()

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

inlinestaticprotected

Get the number of dataReturnIn input ports

Returns

The number of dataReturnIn input ports

Definition at line 239 of file FprimeFramerComponentAc.hpp.

getNum_dataReturnOut_OutputPorts()

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

inlinestaticprotected

Get the number of dataReturnOut output ports

Returns

The number of dataReturnOut output ports

Definition at line 293 of file FprimeFramerComponentAc.hpp.

getNum_timeCaller_OutputPorts()

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

inlinestaticprotected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 252 of file FprimeFramerComponentAc.hpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 699 of file FprimeFramerComponentAc.cpp.

init()

void Svc::FprimeFramerComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize FprimeFramerComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file FprimeFramerComponentAc.cpp.

isConnected_bufferAllocate_OutputPort()

bool Svc::FprimeFramerComponentBase::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 465 of file FprimeFramerComponentAc.cpp.

isConnected_bufferDeallocate_OutputPort()

bool Svc::FprimeFramerComponentBase::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 476 of file FprimeFramerComponentAc.cpp.

isConnected_comStatusOut_OutputPort()

bool Svc::FprimeFramerComponentBase::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 487 of file FprimeFramerComponentAc.cpp.

isConnected_dataOut_OutputPort()

bool Svc::FprimeFramerComponentBase::isConnected_dataOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port dataOut is connected

Returns

Whether port dataOut is connected

Parameters

portNum

The port number

Definition at line 498 of file FprimeFramerComponentAc.cpp.

isConnected_dataReturnOut_OutputPort()

bool Svc::FprimeFramerComponentBase::isConnected_dataReturnOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port dataReturnOut is connected

Returns

Whether port dataReturnOut is connected

Parameters

portNum

The port number

Definition at line 509 of file FprimeFramerComponentAc.cpp.

isConnected_timeCaller_OutputPort()

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

set_bufferAllocate_OutputPort()

void Svc::FprimeFramerComponentBase::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 273 of file FprimeFramerComponentAc.cpp.

set_bufferDeallocate_OutputPort()

void Svc::FprimeFramerComponentBase::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 287 of file FprimeFramerComponentAc.cpp.

set_comStatusOut_OutputPort()

void Svc::FprimeFramerComponentBase::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 301 of file FprimeFramerComponentAc.cpp.

set_dataOut_OutputPort()

void Svc::FprimeFramerComponentBase::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 315 of file FprimeFramerComponentAc.cpp.

set_dataReturnOut_OutputPort()

void Svc::FprimeFramerComponentBase::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 329 of file FprimeFramerComponentAc.cpp.

set_timeCaller_OutputPort()

void Svc::FprimeFramerComponentBase::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 255 of file FprimeFramerComponentAc.cpp.

Friends And Related Function Documentation

FprimeFramerTester

friend class FprimeFramerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 37 of file FprimeFramerComponentAc.hpp.

FprimeFramerTesterBase

friend class FprimeFramerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 35 of file FprimeFramerComponentAc.hpp.

---

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

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