![]() |
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>
Public Member Functions | |
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 |
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 () |
![]() | |
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. | |
Friends | |
class | DpManagerComponentBaseFriend |
Friend class for white-box testing. | |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT } |
![]() | |
Os::Task | m_task |
task object for active component | |
![]() | |
Os::Queue | m_queue |
queue object for active component | |
Auto-generated base for DpManager component.
A component for managing data products
Definition at line 40 of file DpManagerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDIN_INPUT_PORTS |
Definition at line 58 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 63 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 71 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 81 of file DpManagerComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_CLEAR_EVENT_THROTTLE | Clear event throttling. |
Definition at line 88 of file DpManagerComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_BUFFERALLOCATIONFAILED | Buffer allocation failed. |
Definition at line 93 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 98 of file DpManagerComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 103 of file DpManagerComponentAc.hpp.
|
protected |
Construct DpManagerComponentBase object.
compName | The component name |
Definition at line 738 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Destroy DpManagerComponentBase object.
Definition at line 761 of file DpManagerComponentAc.cpp.
|
protected |
Invoke output port bufferGetOut.
portNum | The port number |
size | The requested size |
Definition at line 1233 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 1303 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CLEAR_EVENT_THROTTLE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1370 of file DpManagerComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 1286 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 391 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 406 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 417 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 428 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 439 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of bufferGetOut output ports
Definition at line 853 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 771 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of cmdRegIn output ports
Definition at line 809 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 815 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of eventOut output ports
Definition at line 821 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of productGetIn input ports
Definition at line 781 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of productRequestIn input ports
Definition at line 787 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of productResponseOut output ports
Definition at line 859 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of productSendIn input ports
Definition at line 793 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of productSendOut output ports
Definition at line 865 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of schedIn input ports
Definition at line 799 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of timeGetOut output ports
Definition at line 837 of file DpManagerComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 843 of file DpManagerComponentAc.cpp.
|
protected |
void Svc::DpManagerComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize DpManagerComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 74 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port bufferGetOut is connected
portNum | The port number |
Definition at line 949 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port cmdRegIn is connected
portNum | The port number |
Definition at line 875 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
portNum | The port number |
Definition at line 886 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
portNum | The port number |
Definition at line 897 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port productResponseOut is connected
portNum | The port number |
Definition at line 960 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port productSendOut is connected
portNum | The port number |
Definition at line 971 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port timeGetOut is connected
portNum | The port number |
Definition at line 923 of file DpManagerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
portNum | The port number |
Definition at line 934 of file DpManagerComponentAc.cpp.
|
protected |
Log event BufferAllocationFailed
Buffer allocation failed
id | The container ID |
Definition at line 1385 of file DpManagerComponentAc.cpp.
|
protected |
Reset throttle value for BufferAllocationFailed.
Definition at line 1479 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 988 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 1015 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 1200 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 1248 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 1077 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 1210 of file DpManagerComponentAc.cpp.
|
protected |
Invoke output port productSendOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1267 of file DpManagerComponentAc.cpp.
void Svc::DpManagerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 724 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 1139 of file DpManagerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port schedIn.
portNum | The port number |
context | The call order |
Definition at line 1220 of file DpManagerComponentAc.cpp.
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 546 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 454 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 468 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 482 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 560 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 574 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 514 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 528 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 1634 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 1586 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 1490 of file DpManagerComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 49 of file DpManagerComponentAc.hpp.