![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for DpManager component. More...
#include <Svc/DpManager/DpManagerComponentAc.hpp>
Protected Member Functions | |
| DpManagerComponentBase (const char *compName="") | |
| Construct DpManagerComponentBase object. More... | |
| virtual | ~DpManagerComponentBase () |
| Destroy DpManagerComponentBase object. More... | |
| bool | isConnected_cmdRegIn_OutputPort (FwIndexType portNum) const |
| bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_eventOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_timeGetOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_bufferGetOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_productResponseOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_productSendOut_OutputPort (FwIndexType portNum) const |
| void | cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| Handler base-class function for input port cmdIn. More... | |
| 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... | |
| Fw::Buffer | bufferGetOut_out (FwIndexType portNum, FwSizeType size) const |
| Invoke output port bufferGetOut. More... | |
| void | productResponseOut_out (FwIndexType portNum, FwDpIdType id, const Fw::Buffer &buffer, const Fw::Success &status) const |
| Invoke output port productResponseOut. More... | |
| void | productSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const |
| Invoke output port productSendOut. More... | |
| virtual void | schedInInternal_overflowHook ()=0 |
| Overflow hook for async input port schedInInternal. More... | |
| virtual void | schedInInternal_internalInterfaceHandler ()=0 |
| Internal interface handler for schedInInternal. More... | |
| void | schedInInternal_internalInterfaceInvoke () |
| Internal interface base-class function for schedInInternal. 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 (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const |
| 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) |
| MsgDispatchStatus | dispatchAvailableMessages () |
| dispatches all messages currently in the queue, returning status of the dispatch More... | |
| 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... | |
Static Protected Member Functions | |
| static constexpr FwIndexType | getNum_cmdIn_InputPorts () |
| static constexpr FwIndexType | getNum_productGetIn_InputPorts () |
| static constexpr FwIndexType | getNum_productRequestIn_InputPorts () |
| static constexpr FwIndexType | getNum_productSendIn_InputPorts () |
| static constexpr FwIndexType | getNum_schedIn_InputPorts () |
| static constexpr FwIndexType | getNum_cmdRegIn_OutputPorts () |
| static constexpr FwIndexType | getNum_cmdResponseOut_OutputPorts () |
| static constexpr FwIndexType | getNum_eventOut_OutputPorts () |
| static constexpr FwIndexType | getNum_timeGetOut_OutputPorts () |
| static constexpr FwIndexType | getNum_tlmOut_OutputPorts () |
| static constexpr FwIndexType | getNum_bufferGetOut_OutputPorts () |
| static constexpr FwIndexType | getNum_productResponseOut_OutputPorts () |
| static constexpr FwIndexType | getNum_productSendOut_OutputPorts () |
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... | |
Auto-generated base for DpManager component.
A component for managing data products
Definition at line 46 of file DpManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDIN_INPUT_PORTS | |
Definition at line 66 of file DpManagerComponentAc.hpp.
|
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 71 of file DpManagerComponentAc.hpp.
|
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 79 of file DpManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_BUFFERGETOUT_OUTPUT_PORTS | |
| NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS | |
| NUM_PRODUCTSENDOUT_OUTPUT_PORTS | |
Definition at line 89 of file DpManagerComponentAc.hpp.
|
protected |
Command opcodes.
| Enumerator | |
|---|---|
| OPCODE_CLEAR_EVENT_THROTTLE | Clear event throttling. |
Definition at line 96 of file DpManagerComponentAc.hpp.
|
protected |
Event IDs.
| Enumerator | |
|---|---|
| EVENTID_BUFFERALLOCATIONFAILED | Buffer allocation failed. |
Definition at line 101 of file DpManagerComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
| Enumerator | |
|---|---|
| EVENTID_BUFFERALLOCATIONFAILED_THROTTLE | Throttle reset count for BufferAllocationFailed. |
Definition at line 106 of file DpManagerComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 111 of file DpManagerComponentAc.hpp.
|
protected |
Construct DpManagerComponentBase object.
| compName | The component name |
Definition at line 773 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Destroy DpManagerComponentBase object.
Definition at line 780 of file DpManagerComponentAc.cpp.
|
protected |
Invoke output port bufferGetOut.
| portNum | The port number |
| size | The requested size |
Definition at line 1149 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CLEAR_EVENT_THROTTLE
Clear event throttling
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CLEAR_EVENT_THROTTLE
Clear event throttling
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1283 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CLEAR_EVENT_THROTTLE.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1350 of file DpManagerComponentAc.cpp.
|
protected |
Handler base-class function for input port cmdIn.
| portNum | The port number |
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 911 of file DpManagerComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 1266 of file DpManagerComponentAc.cpp.
| Fw::InputCmdPort * Svc::DpManagerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 411 of file DpManagerComponentAc.cpp.
| Fw::InputDpGetPort * Svc::DpManagerComponentBase::get_productGetIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 430 of file DpManagerComponentAc.cpp.
| Fw::InputDpRequestPort * Svc::DpManagerComponentBase::get_productRequestIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 441 of file DpManagerComponentAc.cpp.
| Fw::InputDpSendPort * Svc::DpManagerComponentBase::get_productSendIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 452 of file DpManagerComponentAc.cpp.
| Svc::InputSchedPort * Svc::DpManagerComponentBase::get_schedIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 463 of file DpManagerComponentAc.cpp.
|
inlinestaticprotected |
Get the number of bufferGetOut output ports
Definition at line 468 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdIn input ports
Definition at line 369 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdRegIn output ports
Definition at line 416 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdResponseOut output ports
Definition at line 423 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of eventOut output ports
Definition at line 430 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of productGetIn input ports
Definition at line 382 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of productRequestIn input ports
Definition at line 389 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of productResponseOut output ports
Definition at line 475 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of productSendIn input ports
Definition at line 396 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of productSendOut output ports
Definition at line 482 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of schedIn input ports
Definition at line 403 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeGetOut output ports
Definition at line 448 of file DpManagerComponentAc.hpp.
|
inlinestaticprotected |
Get the number of tlmOut output ports
Definition at line 455 of file DpManagerComponentAc.hpp.
|
protected |
| void Svc::DpManagerComponentBase::init | ( | FwSizeType | queueDepth, |
| FwEnumStoreType | instance = 0 |
||
| ) |
Initialize DpManagerComponentBase object.
| queueDepth | The queue depth |
| instance | The instance number |
Definition at line 66 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port bufferGetOut is connected
| portNum | The port number |
Definition at line 870 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port cmdRegIn is connected
| portNum | The port number |
Definition at line 792 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
| portNum | The port number |
Definition at line 803 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
| portNum | The port number |
Definition at line 814 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port productResponseOut is connected
| portNum | The port number |
Definition at line 881 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port productSendOut is connected
| portNum | The port number |
Definition at line 892 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port timeGetOut is connected
| portNum | The port number |
Definition at line 840 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
| portNum | The port number |
Definition at line 851 of file DpManagerComponentAc.cpp.
|
protected |
Log event BufferAllocationFailed
Buffer allocation failed
| id | The container ID |
Definition at line 1365 of file DpManagerComponentAc.cpp.
|
protected |
Reset throttle value for BufferAllocationFailed.
Definition at line 1459 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port productGetIn.
| portNum | The port number |
| id | The container ID (input) |
| dataSize | The data size of the requested buffer (input) |
| buffer | The buffer (output) |
|
protected |
Handler base-class function for input port productGetIn.
| 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 945 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port productRequestIn.
| portNum | The port number |
| id | The container ID |
| dataSize | The data size of the requested buffer |
|
protected |
Handler base-class function for input port productRequestIn.
| portNum | The port number |
| id | The container ID |
| dataSize | The data size of the requested buffer |
Definition at line 972 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port productRequestIn.
| portNum | The port number |
| id | The container ID |
| dataSize | The data size of the requested buffer |
Definition at line 1123 of file DpManagerComponentAc.cpp.
|
protected |
Invoke output port productResponseOut.
| portNum | The port number |
| id | The container ID |
| buffer | The buffer |
| status | The status |
Definition at line 1169 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port productSendIn.
| portNum | The port number |
| id | The container ID |
| buffer | The buffer |
|
protected |
Handler base-class function for input port productSendIn.
| portNum | The port number |
| id | The container ID |
| buffer | The buffer |
Definition at line 1034 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port productSendIn.
| portNum | The port number |
| id | The container ID |
| buffer | The buffer |
Definition at line 1133 of file DpManagerComponentAc.cpp.
|
protected |
Invoke output port productSendOut.
| portNum | The port number |
| fwBuffer | The buffer |
Definition at line 1193 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 758 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port schedIn.
| portNum | The port number |
| context | The call order |
|
protected |
Handler base-class function for input port schedIn.
| portNum | The port number |
| context | The call order |
Definition at line 1096 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Internal interface handler for schedInInternal.
|
protected |
Internal interface base-class function for schedInInternal.
Definition at line 1227 of file DpManagerComponentAc.cpp.
|
protectedpure virtual |
Overflow hook for async input port schedInInternal.
| void Svc::DpManagerComponentBase::set_bufferGetOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferGetPort * | port | ||
| ) |
Connect port to bufferGetOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 578 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_cmdRegIn_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to cmdRegIn[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 482 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to cmdResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 496 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_eventOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to eventOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 510 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_productResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputDpResponsePort * | port | ||
| ) |
Connect port to productResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 592 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_productSendOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputBufferSendPort * | port | ||
| ) |
Connect port to productSendOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 606 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_timeGetOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeGetOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 542 of file DpManagerComponentAc.cpp.
| void Svc::DpManagerComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to tlmOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 556 of file DpManagerComponentAc.cpp.
|
protected |
Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written
| id | The channel id |
| _tlmBuff | The serialized telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1470 of file DpManagerComponentAc.cpp.
|
protected |
Write telemetry channel NumBytes
Number of bytes handled
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1612 of file DpManagerComponentAc.cpp.
|
protected |
Write telemetry channel NumDataProducts
Number of data products handled
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1575 of file DpManagerComponentAc.cpp.
|
protected |
Write telemetry channel NumFailedAllocations
The number of failed buffer allocations
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1538 of file DpManagerComponentAc.cpp.
|
protected |
Write telemetry channel NumSuccessfulAllocations
The number of successful buffer allocations
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1501 of file DpManagerComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 57 of file DpManagerComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 55 of file DpManagerComponentAc.hpp.