#include <Fw/Dp/DpGetPortAc.hpp>

Inheritance diagram for Fw::InputDpGetPort:

Public Types
enum	{ SERIALIZED_SIZE }

typedef Fw::Success(*	CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)
	The port callback function type. More...

Public Member Functions
	InputDpGetPort ()
	Constructor. More...

void	init ()
	Initialization function. More...

void	addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
	Register a component. More...

Fw::Success	invoke (FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)
	Invoke a port interface. More...

Public Member Functions inherited from Fw::InputPortBase
void	setPortNum (NATIVE_INT_TYPE portNum)

Public Member Functions inherited from Fw::PortBase
bool	isConnected ()

Additional Inherited Members
Protected Member Functions inherited from Fw::InputPortBase
	InputPortBase ()

virtual	~InputPortBase ()

Protected Member Functions inherited from Fw::PortBase
	PortBase ()

virtual	~PortBase ()

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Protected Attributes inherited from Fw::InputPortBase
PassiveComponentBase *	m_comp

NATIVE_INT_TYPE	m_portNum

Protected Attributes inherited from Fw::PortBase
Fw::ObjBase *	m_connObj

Detailed Description

Input DpGet port Port for synchronously getting a data product buffer Returns the status

On return, buffer should be set to a valid buffer large enough to hold a data product packet with the requested data size (if status is SUCCESS) or an invalid buffer (if status is FAILURE).

Definition at line 30 of file DpGetPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Fw::Success(* Fw::InputDpGetPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)

The port callback function type.

Definition at line 55 of file DpGetPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representations of the port arguments.

Definition at line 40 of file DpGetPortAc.hpp.

Constructor & Destructor Documentation

◆ InputDpGetPort()

Fw::InputDpGetPort::InputDpGetPort ( )

Constructor.

Definition at line 17 of file DpGetPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Fw::InputDpGetPort::addCallComp	(	Fw::PassiveComponentBase *	callComp,
		CompFuncPtr	funcPtr
	)

Register a component.

Parameters

callComp	The containing component
funcPtr	The port callback function

Definition at line 31 of file DpGetPortAc.cpp.

◆ init()

void Fw::InputDpGetPort::init ( )

virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 25 of file DpGetPortAc.cpp.

◆ invoke()

Fw::Success Fw::InputDpGetPort::invoke	(	FwDpIdType	id,
		FwSizeType	dataSize,
		Fw::Buffer &	buffer
	)

Invoke a port interface.