![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/DpManager/DpManager.hpp>
Public Member Functions | |
DpManager (const char *const compName) | |
Construct a DpManager. | |
~DpManager () | |
Destroy the DpManager. | |
![]() | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize DpManagerComponentBase object. | |
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]. | |
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. | |
![]() | |
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. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT } |
![]() | |
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... | |
![]() | |
enum | Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE } |
Tracks the lifecycle of the component. More... | |
![]() | |
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) |
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. | |
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 () |
![]() | |
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. | |
![]() | |
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 | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. | |
virtual | ~PassiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. | |
virtual | ~ObjBase () |
Destructor. | |
void | init () |
Object initializer. | |
![]() | |
Os::Task | m_task |
task object for active component | |
![]() | |
Os::Queue | m_queue |
queue object for active component | |
Definition at line 17 of file DpManager.hpp.
|
explicit |
Construct a DpManager.
compName | The component name |
Definition at line 16 of file DpManager.cpp.
Svc::DpManager::~DpManager | ( | ) |
Destroy the DpManager.
Definition at line 23 of file DpManager.cpp.