Svc::DpManagerComponentBase Class Reference

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

#include <Svc/DpManager/DpManagerComponentAc.hpp>

Inheritance diagram for Svc::DpManagerComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize DpManagerComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Fw::InputDpGetPort *	get_productGetIn_InputPort (FwIndexType portNum)
Fw::InputDpRequestPort *	get_productRequestIn_InputPort (FwIndexType portNum)
Fw::InputDpSendPort *	get_productSendIn_InputPort (FwIndexType portNum)
Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)
void	set_cmdRegIn_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegIn[portNum]. More...
void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...
void	set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...
void	set_timeGetOut_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeGetOut[portNum]. More...
void	set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum]. More...
void	set_bufferGetOut_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to bufferGetOut[portNum]. More...
void	set_productResponseOut_OutputPort (FwIndexType portNum, Fw::InputDpResponsePort *port)
	Connect port to productResponseOut[portNum]. More...
void	set_productSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to productSendOut[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...
void	exit ()
	exit task in active component More...
Os::Task::Status	join ()
	Join the thread. More...
	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{ NUM_PRODUCTGETIN_INPUT_PORTS = 5, NUM_PRODUCTREQUESTIN_INPUT_PORTS = 5, NUM_PRODUCTSENDIN_INPUT_PORTS = 5, NUM_SCHEDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_CMDREGIN_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,   NUM_TIMEGETOUT_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_BUFFERGETOUT_OUTPUT_PORTS = 5, NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS = 5, NUM_PRODUCTSENDOUT_OUTPUT_PORTS = 5 }
	Enumerations for numbers of typed output ports. More...
enum	{ OPCODE_CLEAR_EVENT_THROTTLE = 0x0 }
	Command opcodes. More...
enum	{ EVENTID_BUFFERALLOCATIONFAILED = 0x0 }
	Event IDs. More...
enum	{ EVENTID_BUFFERALLOCATIONFAILED_THROTTLE = 10 }
	Event throttle values: sets initial value of countdown variables. More...
enum	{ CHANNELID_NUMSUCCESSFULALLOCATIONS = 0x0, CHANNELID_NUMFAILEDALLOCATIONS = 0x1, CHANNELID_NUMDATAPRODUCTS = 0x2, CHANNELID_NUMBYTES = 0x3 }
	Channel IDs. More...
Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions
	DpManagerComponentBase (const char *compName="")
	Construct DpManagerComponentBase object. More...
virtual	~DpManagerComponentBase ()
	Destroy DpManagerComponentBase object. More...
FwIndexType	getNum_cmdIn_InputPorts () const
FwIndexType	getNum_productGetIn_InputPorts () const
FwIndexType	getNum_productRequestIn_InputPorts () const
FwIndexType	getNum_productSendIn_InputPorts () const
FwIndexType	getNum_schedIn_InputPorts () const
FwIndexType	getNum_cmdRegIn_OutputPorts () const
FwIndexType	getNum_cmdResponseOut_OutputPorts () const
FwIndexType	getNum_eventOut_OutputPorts () const
FwIndexType	getNum_timeGetOut_OutputPorts () const
FwIndexType	getNum_tlmOut_OutputPorts () const
FwIndexType	getNum_bufferGetOut_OutputPorts () const
FwIndexType	getNum_productResponseOut_OutputPorts () const
FwIndexType	getNum_productSendOut_OutputPorts () const
bool	isConnected_cmdRegIn_OutputPort (FwIndexType portNum)
bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)
bool	isConnected_eventOut_OutputPort (FwIndexType portNum)
bool	isConnected_timeGetOut_OutputPort (FwIndexType portNum)
bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)
bool	isConnected_bufferGetOut_OutputPort (FwIndexType portNum)
bool	isConnected_productResponseOut_OutputPort (FwIndexType portNum)
bool	isConnected_productSendOut_OutputPort (FwIndexType portNum)
virtual Fw::Success	productGetIn_handler (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)=0
	Handler for input port productGetIn. More...
virtual void	productRequestIn_handler (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)=0
	Handler for input port productRequestIn. More...
virtual void	productSendIn_handler (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)=0
	Handler for input port productSendIn. More...
virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn. More...
Fw::Success	productGetIn_handlerBase (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)
	Handler base-class function for input port productGetIn. More...
void	productRequestIn_handlerBase (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)
	Handler base-class function for input port productRequestIn. More...
void	productSendIn_handlerBase (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)
	Handler base-class function for input port productSendIn. More...
void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn. More...
virtual void	productRequestIn_preMsgHook (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)
	Pre-message hook for async input port productRequestIn. More...
virtual void	productSendIn_preMsgHook (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)
	Pre-message hook for async input port productSendIn. More...
virtual void	schedIn_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port schedIn. More...
Fw::Buffer	bufferGetOut_out (FwIndexType portNum, FwSizeType size)
	Invoke output port bufferGetOut. More...
void	productResponseOut_out (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer, const Fw::Success &status)
	Invoke output port productResponseOut. More...
void	productSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port productSendOut. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
virtual void	CLEAR_EVENT_THROTTLE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
void	CLEAR_EVENT_THROTTLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
virtual void	CLEAR_EVENT_THROTTLE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CLEAR_EVENT_THROTTLE. More...
void	log_WARNING_HI_BufferAllocationFailed (FwDpIdType id)
void	log_WARNING_HI_BufferAllocationFailed_ThrottleClear ()
	Reset throttle value for BufferAllocationFailed. More...
void	tlmWrite_NumSuccessfulAllocations (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_NumFailedAllocations (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_NumDataProducts (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_NumBytes (U64 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime () const
Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...
virtual	~ActiveComponentBase ()
	Destructor. More...
void	init (FwEnumStoreType instance)
	initialization code More...
virtual void	preamble ()
	A function that will be called before the event loop is entered. More...
MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...
virtual void	finalizer ()
	A function that will be called after exiting the loop. More...
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...
virtual	~QueuedComponentBase ()
	Destructor. More...
void	init (FwEnumStoreType instance)
	initialization function More...
Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)
FwSizeType	getNumMsgsDropped ()
	return number of messages dropped More...
void	incNumMsgDropped ()
	increment the number of messages dropped 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	DpManagerTesterBase
	Friend class tester to support autocoded test harness. More...
class	DpManagerTester
	Friend class tester implementation to support white-box testing. More...

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }
Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }
Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Auto-generated base for DpManager component.

A component for managing data products

Definition at line 43 of file DpManagerComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 63 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PRODUCTGETIN_INPUT_PORTS
NUM_PRODUCTREQUESTIN_INPUT_PORTS
NUM_PRODUCTSENDIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 68 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGIN_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMEGETOUT_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 76 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERGETOUT_OUTPUT_PORTS
NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS
NUM_PRODUCTSENDOUT_OUTPUT_PORTS

Definition at line 86 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_CLEAR_EVENT_THROTTLE	Clear event throttling.

Definition at line 93 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_BUFFERALLOCATIONFAILED	Buffer allocation failed.

Definition at line 98 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_BUFFERALLOCATIONFAILED_THROTTLE	Throttle reset count for BufferAllocationFailed.

Definition at line 103 of file DpManagerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_NUMSUCCESSFULALLOCATIONS	Channel ID for NumSuccessfulAllocations.
CHANNELID_NUMFAILEDALLOCATIONS	Channel ID for NumFailedAllocations.
CHANNELID_NUMDATAPRODUCTS	Channel ID for NumDataProducts.
CHANNELID_NUMBYTES	Channel ID for NumBytes.

Definition at line 108 of file DpManagerComponentAc.hpp.

Constructor & Destructor Documentation

DpManagerComponentBase()

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

protected

Construct DpManagerComponentBase object.

Parameters

compName

The component name

Definition at line 739 of file DpManagerComponentAc.cpp.

~DpManagerComponentBase()

Svc::DpManagerComponentBase::~DpManagerComponentBase ( )

protectedvirtual

Destroy DpManagerComponentBase object.

Definition at line 762 of file DpManagerComponentAc.cpp.

Member Function Documentation

bufferGetOut_out()

Fw::Buffer Svc::DpManagerComponentBase::bufferGetOut_out ( FwIndexType  portNum, FwSizeType  size  )

protected

Invoke output port bufferGetOut.

Parameters

portNum	The port number
size	The requested size

Definition at line 1234 of file DpManagerComponentAc.cpp.

CLEAR_EVENT_THROTTLE_cmdHandler()

virtual void Svc::DpManagerComponentBase::CLEAR_EVENT_THROTTLE_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CLEAR_EVENT_THROTTLE

Clear event throttling

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CLEAR_EVENT_THROTTLE_cmdHandlerBase()

void Svc::DpManagerComponentBase::CLEAR_EVENT_THROTTLE_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CLEAR_EVENT_THROTTLE

Clear event throttling

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1319 of file DpManagerComponentAc.cpp.

CLEAR_EVENT_THROTTLE_preMsgHook()

void Svc::DpManagerComponentBase::CLEAR_EVENT_THROTTLE_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CLEAR_EVENT_THROTTLE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1386 of file DpManagerComponentAc.cpp.

cmdResponse_out()

void Svc::DpManagerComponentBase::cmdResponse_out ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdResponse  response  )

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 1302 of file DpManagerComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::DpManagerComponentBase::get_cmdIn_InputPort

(

FwIndexType

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 392 of file DpManagerComponentAc.cpp.

get_productGetIn_InputPort()

Fw::InputDpGetPort * Svc::DpManagerComponentBase::get_productGetIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

productGetIn[portNum]

Parameters

portNum

The port number

Definition at line 407 of file DpManagerComponentAc.cpp.

get_productRequestIn_InputPort()

Fw::InputDpRequestPort * Svc::DpManagerComponentBase::get_productRequestIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

productRequestIn[portNum]

Parameters

portNum

The port number

Definition at line 418 of file DpManagerComponentAc.cpp.

get_productSendIn_InputPort()

Fw::InputDpSendPort * Svc::DpManagerComponentBase::get_productSendIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

productSendIn[portNum]

Parameters

portNum

The port number

Definition at line 429 of file DpManagerComponentAc.cpp.

get_schedIn_InputPort()

Svc::InputSchedPort * Svc::DpManagerComponentBase::get_schedIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

schedIn[portNum]

Parameters

portNum

The port number

Definition at line 440 of file DpManagerComponentAc.cpp.

getNum_bufferGetOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_bufferGetOut_OutputPorts ( ) const

protected

Get the number of bufferGetOut output ports

Returns

The number of bufferGetOut output ports

Definition at line 854 of file DpManagerComponentAc.cpp.

getNum_cmdIn_InputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 772 of file DpManagerComponentAc.cpp.

getNum_cmdRegIn_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_cmdRegIn_OutputPorts ( ) const

protected

Get the number of cmdRegIn output ports

Returns

The number of cmdRegIn output ports

Definition at line 810 of file DpManagerComponentAc.cpp.

getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 816 of file DpManagerComponentAc.cpp.

getNum_eventOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns

The number of eventOut output ports

Definition at line 822 of file DpManagerComponentAc.cpp.

getNum_productGetIn_InputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_productGetIn_InputPorts ( ) const

protected

Get the number of productGetIn input ports

Returns

The number of productGetIn input ports

Definition at line 782 of file DpManagerComponentAc.cpp.

getNum_productRequestIn_InputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_productRequestIn_InputPorts ( ) const

protected

Get the number of productRequestIn input ports

Returns

The number of productRequestIn input ports

Definition at line 788 of file DpManagerComponentAc.cpp.

getNum_productResponseOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_productResponseOut_OutputPorts ( ) const

protected

Get the number of productResponseOut output ports

Returns

The number of productResponseOut output ports

Definition at line 860 of file DpManagerComponentAc.cpp.

getNum_productSendIn_InputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_productSendIn_InputPorts ( ) const

protected

Get the number of productSendIn input ports

Returns

The number of productSendIn input ports

Definition at line 794 of file DpManagerComponentAc.cpp.

getNum_productSendOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_productSendOut_OutputPorts ( ) const

protected

Get the number of productSendOut output ports

Returns

The number of productSendOut output ports

Definition at line 866 of file DpManagerComponentAc.cpp.

getNum_schedIn_InputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_schedIn_InputPorts ( ) const

protected

Get the number of schedIn input ports

Returns

The number of schedIn input ports

Definition at line 800 of file DpManagerComponentAc.cpp.

getNum_timeGetOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_timeGetOut_OutputPorts ( ) const

protected

Get the number of timeGetOut output ports

Returns

The number of timeGetOut output ports

Definition at line 838 of file DpManagerComponentAc.cpp.

getNum_tlmOut_OutputPorts()

FwIndexType Svc::DpManagerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 844 of file DpManagerComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 1702 of file DpManagerComponentAc.cpp.

init()

void Svc::DpManagerComponentBase::init	(	FwSizeType	queueDepth,
		FwEnumStoreType	instance = 0
	)

Initialize DpManagerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 75 of file DpManagerComponentAc.cpp.

isConnected_bufferGetOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_bufferGetOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port bufferGetOut is connected

Returns

Whether port bufferGetOut is connected

Parameters

portNum

The port number

Definition at line 950 of file DpManagerComponentAc.cpp.

isConnected_cmdRegIn_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_cmdRegIn_OutputPort ( FwIndexType  portNum )

protected

Check whether port cmdRegIn is connected

Returns

Whether port cmdRegIn is connected

Parameters

portNum

The port number

Definition at line 876 of file DpManagerComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port cmdResponseOut is connected

Returns

Whether port cmdResponseOut is connected

Parameters

portNum

The port number

Definition at line 887 of file DpManagerComponentAc.cpp.

isConnected_eventOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_eventOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port eventOut is connected

Returns

Whether port eventOut is connected

Parameters

portNum

The port number

Definition at line 898 of file DpManagerComponentAc.cpp.

isConnected_productResponseOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_productResponseOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port productResponseOut is connected

Returns

Whether port productResponseOut is connected

Parameters

portNum

The port number

Definition at line 961 of file DpManagerComponentAc.cpp.

isConnected_productSendOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_productSendOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port productSendOut is connected

Returns

Whether port productSendOut is connected

Parameters

portNum

The port number

Definition at line 972 of file DpManagerComponentAc.cpp.

isConnected_timeGetOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_timeGetOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port timeGetOut is connected

Returns

Whether port timeGetOut is connected

Parameters

portNum

The port number

Definition at line 924 of file DpManagerComponentAc.cpp.

isConnected_tlmOut_OutputPort()

bool Svc::DpManagerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port tlmOut is connected

Returns

Whether port tlmOut is connected

Parameters

portNum

The port number

Definition at line 935 of file DpManagerComponentAc.cpp.

log_WARNING_HI_BufferAllocationFailed()

void Svc::DpManagerComponentBase::log_WARNING_HI_BufferAllocationFailed ( FwDpIdType  id )

protected

Log event BufferAllocationFailed

Buffer allocation failed

Parameters

id	The container ID

Definition at line 1401 of file DpManagerComponentAc.cpp.

log_WARNING_HI_BufferAllocationFailed_ThrottleClear()

void Svc::DpManagerComponentBase::log_WARNING_HI_BufferAllocationFailed_ThrottleClear ( )

protected

Reset throttle value for BufferAllocationFailed.

Definition at line 1495 of file DpManagerComponentAc.cpp.

productGetIn_handler()

virtual Fw::Success Svc::DpManagerComponentBase::productGetIn_handler ( FwIndexType  portNum, FwDpIdType  id, FwSizeType  dataSize, Fw::Buffer &  buffer  )

protectedpure virtual

Handler for input port productGetIn.

Parameters

portNum	The port number
id	The container ID (input)
dataSize	The data size of the requested buffer (input)
buffer	The buffer (output)

productGetIn_handlerBase()

Fw::Success Svc::DpManagerComponentBase::productGetIn_handlerBase ( FwIndexType  portNum, FwDpIdType  id, FwSizeType  dataSize, Fw::Buffer &  buffer  )

protected

Handler base-class function for input port productGetIn.

Parameters

portNum	The port number
id	The container ID (input)
dataSize	The data size of the requested buffer (input)
buffer	The buffer (output)

Definition at line 989 of file DpManagerComponentAc.cpp.

productRequestIn_handler()

virtual void Svc::DpManagerComponentBase::productRequestIn_handler ( FwIndexType  portNum, FwDpIdType  id, FwSizeType  dataSize  )

protectedpure virtual

Handler for input port productRequestIn.

Parameters

portNum	The port number
id	The container ID
dataSize	The data size of the requested buffer

productRequestIn_handlerBase()

void Svc::DpManagerComponentBase::productRequestIn_handlerBase ( FwIndexType  portNum, FwDpIdType  id, FwSizeType  dataSize  )

protected

Handler base-class function for input port productRequestIn.

Parameters

portNum	The port number
id	The container ID
dataSize	The data size of the requested buffer

Definition at line 1016 of file DpManagerComponentAc.cpp.

productRequestIn_preMsgHook()

void Svc::DpManagerComponentBase::productRequestIn_preMsgHook ( FwIndexType  portNum, FwDpIdType  id, FwSizeType  dataSize  )

protectedvirtual

Pre-message hook for async input port productRequestIn.

Parameters

portNum	The port number
id	The container ID
dataSize	The data size of the requested buffer

Definition at line 1201 of file DpManagerComponentAc.cpp.

productResponseOut_out()

void Svc::DpManagerComponentBase::productResponseOut_out ( FwIndexType  portNum, FwDpIdType  id, const Fw::Buffer &  buffer, const Fw::Success &  status  )

protected

Invoke output port productResponseOut.

Parameters

portNum	The port number
id	The container ID
buffer	The buffer
status	The status

Definition at line 1254 of file DpManagerComponentAc.cpp.

productSendIn_handler()

virtual void Svc::DpManagerComponentBase::productSendIn_handler ( FwIndexType  portNum, FwDpIdType  id, const Fw::Buffer &  buffer  )

protectedpure virtual

Handler for input port productSendIn.

Parameters

portNum	The port number
id	The container ID
buffer	The buffer

productSendIn_handlerBase()

void Svc::DpManagerComponentBase::productSendIn_handlerBase ( FwIndexType  portNum, FwDpIdType  id, const Fw::Buffer &  buffer  )

protected

Handler base-class function for input port productSendIn.

Parameters

portNum	The port number
id	The container ID
buffer	The buffer

Definition at line 1078 of file DpManagerComponentAc.cpp.

productSendIn_preMsgHook()

void Svc::DpManagerComponentBase::productSendIn_preMsgHook ( FwIndexType  portNum, FwDpIdType  id, const Fw::Buffer &  buffer  )

protectedvirtual

Pre-message hook for async input port productSendIn.

Parameters

portNum	The port number
id	The container ID
buffer	The buffer

Definition at line 1211 of file DpManagerComponentAc.cpp.

productSendOut_out()

void Svc::DpManagerComponentBase::productSendOut_out ( FwIndexType  portNum, Fw::Buffer &  fwBuffer  )

protected

Invoke output port productSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1278 of file DpManagerComponentAc.cpp.

regCommands()

void Svc::DpManagerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 725 of file DpManagerComponentAc.cpp.

schedIn_handler()

virtual void Svc::DpManagerComponentBase::schedIn_handler ( FwIndexType  portNum, U32  context  )

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

schedIn_handlerBase()

void Svc::DpManagerComponentBase::schedIn_handlerBase ( FwIndexType  portNum, U32  context  )

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1140 of file DpManagerComponentAc.cpp.

schedIn_preMsgHook()

void Svc::DpManagerComponentBase::schedIn_preMsgHook ( FwIndexType  portNum, U32  context  )

protectedvirtual

Pre-message hook for async input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1221 of file DpManagerComponentAc.cpp.

set_bufferGetOut_OutputPort()

void Svc::DpManagerComponentBase::set_bufferGetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to bufferGetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 547 of file DpManagerComponentAc.cpp.

set_cmdRegIn_OutputPort()

void Svc::DpManagerComponentBase::set_cmdRegIn_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegIn[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 455 of file DpManagerComponentAc.cpp.

set_cmdResponseOut_OutputPort()

void Svc::DpManagerComponentBase::set_cmdResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 469 of file DpManagerComponentAc.cpp.

set_eventOut_OutputPort()

void Svc::DpManagerComponentBase::set_eventOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 483 of file DpManagerComponentAc.cpp.

set_productResponseOut_OutputPort()

void Svc::DpManagerComponentBase::set_productResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputDpResponsePort *	port
	)

Connect port to productResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 561 of file DpManagerComponentAc.cpp.

set_productSendOut_OutputPort()

void Svc::DpManagerComponentBase::set_productSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to productSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 575 of file DpManagerComponentAc.cpp.

set_timeGetOut_OutputPort()

void Svc::DpManagerComponentBase::set_timeGetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeGetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 515 of file DpManagerComponentAc.cpp.

set_tlmOut_OutputPort()

void Svc::DpManagerComponentBase::set_tlmOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 529 of file DpManagerComponentAc.cpp.

tlmWrite_NumBytes()

void Svc::DpManagerComponentBase::tlmWrite_NumBytes ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel NumBytes

Number of bytes handled

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1650 of file DpManagerComponentAc.cpp.

tlmWrite_NumDataProducts()

void Svc::DpManagerComponentBase::tlmWrite_NumDataProducts ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel NumDataProducts

Number of data products handled

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1602 of file DpManagerComponentAc.cpp.

tlmWrite_NumFailedAllocations()

void Svc::DpManagerComponentBase::tlmWrite_NumFailedAllocations ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel NumFailedAllocations

The number of failed buffer allocations

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1554 of file DpManagerComponentAc.cpp.

tlmWrite_NumSuccessfulAllocations()

void Svc::DpManagerComponentBase::tlmWrite_NumSuccessfulAllocations ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel NumSuccessfulAllocations

The number of successful buffer allocations

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1506 of file DpManagerComponentAc.cpp.

Friends And Related Function Documentation

DpManagerTester

friend class DpManagerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 54 of file DpManagerComponentAc.hpp.

DpManagerTesterBase

friend class DpManagerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 52 of file DpManagerComponentAc.hpp.

---

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

• Svc/DpManager/DpManagerComponentAc.hpp
• Svc/DpManager/DpManagerComponentAc.cpp