F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::DpManager Class Reference

#include <Svc/DpManager/DpManager.hpp>

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

Public Member Functions

 DpManager (const char *const compName)
 Construct a DpManager. More...
 
 ~DpManager ()
 Destroy the DpManager. More...
 
- Public Member Functions inherited from Svc::DpManagerComponentBase
void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize DpManagerComponentBase object. More...
 
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]. 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 (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 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 U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

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 Types inherited from Svc::DpManagerComponentBase
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 inherited from Svc::DpManagerComponentBase
 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)
 
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, U32 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...
 
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 (U32 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 ()
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor. More...
 
virtual ~ActiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE 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 (NATIVE_INT_TYPE instance)
 initialization function More...
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
NATIVE_INT_TYPE 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 (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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...
 
- 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

Definition at line 17 of file DpManager.hpp.

Constructor & Destructor Documentation

◆ DpManager()

Svc::DpManager::DpManager ( const char *const  compName)
explicit

Construct a DpManager.

Parameters
compNameThe component name

Definition at line 16 of file DpManager.cpp.

◆ ~DpManager()

Svc::DpManager::~DpManager ( )

Destroy the DpManager.

Definition at line 23 of file DpManager.cpp.


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