F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::DpManagerComponentBase Class Referenceabstract

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

#include <Svc/DpManager/DpManagerComponentAc.hpp>

Inheritance diagram for Svc::DpManagerComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::DpManager

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize DpManagerComponentBase object.
 
Fw::InputCmdPortget_cmdIn_InputPort (FwIndexType portNum)
 
Fw::InputDpGetPortget_productGetIn_InputPort (FwIndexType portNum)
 
Fw::InputDpRequestPortget_productRequestIn_InputPort (FwIndexType portNum)
 
Fw::InputDpSendPortget_productSendIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_schedIn_InputPort (FwIndexType portNum)
 
void set_cmdRegIn_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to cmdRegIn[portNum].
 
void set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to cmdResponseOut[portNum].
 
void set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to eventOut[portNum].
 
void set_timeGetOut_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to timeGetOut[portNum].
 
void set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to tlmOut[portNum].
 
void set_bufferGetOut_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
 Connect port to bufferGetOut[portNum].
 
void set_productResponseOut_OutputPort (FwIndexType portNum, Fw::InputDpResponsePort *port)
 Connect port to productResponseOut[portNum].
 
void set_productSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to productSendOut[portNum].
 
void regCommands ()
 Register commands with the Command Dispatcher.
 
- Public Member Functions inherited from Fw::ActiveComponentBase
void start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
 called by instantiator when task is to be started
 
void exit ()
 exit task in active component
 
Os::Task::Status join ()
 Join the thread.
 
 DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
 Join to thread with discarded value_ptr.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 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.
 
virtual ~DpManagerComponentBase ()
 Destroy DpManagerComponentBase object.
 
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.
 
virtual void productRequestIn_handler (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)=0
 Handler for input port productRequestIn.
 
virtual void productSendIn_handler (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)=0
 Handler for input port productSendIn.
 
virtual void schedIn_handler (FwIndexType portNum, U32 context)=0
 Handler for input port schedIn.
 
Fw::Success productGetIn_handlerBase (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer)
 Handler base-class function for input port productGetIn.
 
void productRequestIn_handlerBase (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)
 Handler base-class function for input port productRequestIn.
 
void productSendIn_handlerBase (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)
 Handler base-class function for input port productSendIn.
 
void schedIn_handlerBase (FwIndexType portNum, U32 context)
 Handler base-class function for input port schedIn.
 
virtual void productRequestIn_preMsgHook (FwIndexType portNum, FwDpIdType id, FwSizeType dataSize)
 Pre-message hook for async input port productRequestIn.
 
virtual void productSendIn_preMsgHook (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer)
 Pre-message hook for async input port productSendIn.
 
virtual void schedIn_preMsgHook (FwIndexType portNum, U32 context)
 Pre-message hook for async input port schedIn.
 
Fw::Buffer bufferGetOut_out (FwIndexType portNum, U32 size)
 Invoke output port bufferGetOut.
 
void productResponseOut_out (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer, const Fw::Success &status)
 Invoke output port productResponseOut.
 
void productSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port productSendOut.
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response.
 
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.
 
void log_WARNING_HI_BufferAllocationFailed (U32 id)
 
void log_WARNING_HI_BufferAllocationFailed_ThrottleClear ()
 Reset throttle value for BufferAllocationFailed.
 
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 ()
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor.
 
virtual ~ActiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization code
 
virtual void preamble ()
 A function that will be called before the event loop is entered.
 
MsgDispatchStatus dispatch ()
 The function that will dispatching messages.
 
virtual void finalizer ()
 A function that will be called after exiting the loop.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 QueuedComponentBase (const char *name)
 Constructor.
 
virtual ~QueuedComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization function
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
NATIVE_INT_TYPE getNumMsgsDropped ()
 return number of messages dropped
 
void incNumMsgDropped ()
 increment the number of messages dropped
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 

Friends

class DpManagerComponentBaseFriend
 Friend class for white-box testing.
 

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
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component
 

Detailed Description

Auto-generated base for DpManager component.

A component for managing data products

Definition at line 40 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 58 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 63 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 71 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 81 of file DpManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Command opcodes.

Enumerator
OPCODE_CLEAR_EVENT_THROTTLE 

Clear event throttling.

Definition at line 88 of file DpManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_BUFFERALLOCATIONFAILED 

Buffer allocation failed.

Definition at line 93 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 98 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 103 of file DpManagerComponentAc.hpp.

Constructor & Destructor Documentation

◆ DpManagerComponentBase()

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

Construct DpManagerComponentBase object.

Parameters
compNameThe component name

Definition at line 738 of file DpManagerComponentAc.cpp.

◆ ~DpManagerComponentBase()

Svc::DpManagerComponentBase::~DpManagerComponentBase ( )
protectedvirtual

Destroy DpManagerComponentBase object.

Definition at line 761 of file DpManagerComponentAc.cpp.

Member Function Documentation

◆ bufferGetOut_out()

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

Invoke output port bufferGetOut.

Parameters
portNumThe port number
sizeThe requested size

Definition at line 1233 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
opCodeThe opcode
cmdSeqThe 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
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1303 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
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1370 of file DpManagerComponentAc.cpp.

◆ cmdResponse_out()

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

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 1286 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
portNumThe port number

Definition at line 391 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
portNumThe port number

Definition at line 406 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
portNumThe port number

Definition at line 417 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
portNumThe port number

Definition at line 428 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
portNumThe port number

Definition at line 439 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 853 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 771 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 809 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 815 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 821 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 781 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 787 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 859 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 793 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 865 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 799 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 837 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 843 of file DpManagerComponentAc.cpp.

◆ getTime()

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

Get the time

\return The current time

Definition at line 1686 of file DpManagerComponentAc.cpp.

◆ init()

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

Initialize DpManagerComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 74 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
portNumThe port number

Definition at line 949 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
portNumThe port number

Definition at line 875 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
portNumThe port number

Definition at line 886 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
portNumThe port number

Definition at line 897 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
portNumThe port number

Definition at line 960 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
portNumThe port number

Definition at line 971 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
portNumThe port number

Definition at line 923 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
portNumThe port number

Definition at line 934 of file DpManagerComponentAc.cpp.

◆ log_WARNING_HI_BufferAllocationFailed()

void Svc::DpManagerComponentBase::log_WARNING_HI_BufferAllocationFailed ( U32  id)
protected

Log event BufferAllocationFailed

Buffer allocation failed

Parameters
idThe container ID

Definition at line 1385 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 1479 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
portNumThe port number
idThe container ID (input)
dataSizeThe data size of the requested buffer (input)
bufferThe 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
portNumThe port number
idThe container ID (input)
dataSizeThe data size of the requested buffer (input)
bufferThe buffer (output)

Definition at line 988 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
portNumThe port number
idThe container ID
dataSizeThe 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
portNumThe port number
idThe container ID
dataSizeThe data size of the requested buffer

Definition at line 1015 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
portNumThe port number
idThe container ID
dataSizeThe data size of the requested buffer

Definition at line 1200 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
portNumThe port number
idThe container ID
bufferThe buffer
statusThe status

Definition at line 1248 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
portNumThe port number
idThe container ID
bufferThe 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
portNumThe port number
idThe container ID
bufferThe buffer

Definition at line 1077 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
portNumThe port number
idThe container ID
bufferThe buffer

Definition at line 1210 of file DpManagerComponentAc.cpp.

◆ productSendOut_out()

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

Invoke output port productSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1267 of file DpManagerComponentAc.cpp.

◆ regCommands()

void Svc::DpManagerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 724 of file DpManagerComponentAc.cpp.

◆ schedIn_handler()

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

Handler for input port schedIn.

Parameters
portNumThe port number
contextThe call order

◆ schedIn_handlerBase()

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

Handler base-class function for input port schedIn.

Parameters
portNumThe port number
contextThe call order

Definition at line 1139 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
portNumThe port number
contextThe call order

Definition at line 1220 of file DpManagerComponentAc.cpp.

◆ set_bufferGetOut_OutputPort()

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

Connect port to bufferGetOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 546 of file DpManagerComponentAc.cpp.

◆ set_cmdRegIn_OutputPort()

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

Connect port to cmdRegIn[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 454 of file DpManagerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 468 of file DpManagerComponentAc.cpp.

◆ set_eventOut_OutputPort()

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

Connect port to eventOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 482 of file DpManagerComponentAc.cpp.

◆ set_productResponseOut_OutputPort()

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

Connect port to productResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 560 of file DpManagerComponentAc.cpp.

◆ set_productSendOut_OutputPort()

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

Connect port to productSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 574 of file DpManagerComponentAc.cpp.

◆ set_timeGetOut_OutputPort()

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

Connect port to timeGetOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 514 of file DpManagerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 528 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1634 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1586 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1538 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1490 of file DpManagerComponentAc.cpp.

Friends And Related Symbol Documentation

◆ DpManagerComponentBaseFriend

friend class DpManagerComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 49 of file DpManagerComponentAc.hpp.


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