![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for ComQueue component. More...
#include <Svc/ComQueue/ComQueueComponentAc.hpp>
Protected Types | |
enum | { NUM_BUFFQUEUEIN_INPUT_PORTS = 1, NUM_COMQUEUEIN_INPUT_PORTS = 2, NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_RUN_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_TIME_OUTPUT_PORTS = 1, NUM_TLM_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output ports. More... | |
enum | { NUM_BUFFQUEUESEND_OUTPUT_PORTS = 1, NUM_COMQUEUESEND_OUTPUT_PORTS = 1, NUM_DEALLOCATE_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
enum | { EVENTID_QUEUEOVERFLOW = 0x0 } |
Event IDs. More... | |
enum | { CHANNELID_COMQUEUEDEPTH = 0x0, CHANNELID_BUFFQUEUEDEPTH = 0x1 } |
Channel IDs. More... | |
![]() | |
enum | Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE } |
Tracks the lifecycle of the component. More... | |
Protected Member Functions | |
ComQueueComponentBase (const char *compName="") | |
Construct ComQueueComponentBase object. More... | |
virtual | ~ComQueueComponentBase () |
Destroy ComQueueComponentBase object. More... | |
FwIndexType | getNum_buffQueueIn_InputPorts () const |
FwIndexType | getNum_comQueueIn_InputPorts () const |
FwIndexType | getNum_comStatusIn_InputPorts () const |
FwIndexType | getNum_run_InputPorts () const |
FwIndexType | getNum_Log_OutputPorts () const |
FwIndexType | getNum_Time_OutputPorts () const |
FwIndexType | getNum_Tlm_OutputPorts () const |
FwIndexType | getNum_buffQueueSend_OutputPorts () const |
FwIndexType | getNum_comQueueSend_OutputPorts () const |
FwIndexType | getNum_deallocate_OutputPorts () const |
bool | isConnected_Log_OutputPort (FwIndexType portNum) |
bool | isConnected_Time_OutputPort (FwIndexType portNum) |
bool | isConnected_Tlm_OutputPort (FwIndexType portNum) |
bool | isConnected_buffQueueSend_OutputPort (FwIndexType portNum) |
bool | isConnected_comQueueSend_OutputPort (FwIndexType portNum) |
bool | isConnected_deallocate_OutputPort (FwIndexType portNum) |
virtual void | buffQueueIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
Handler for input port buffQueueIn. More... | |
virtual void | comQueueIn_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0 |
Handler for input port comQueueIn. More... | |
virtual void | comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0 |
Handler for input port comStatusIn. More... | |
virtual void | run_handler (FwIndexType portNum, U32 context)=0 |
Handler for input port run. More... | |
void | buffQueueIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port buffQueueIn. More... | |
void | comQueueIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Handler base-class function for input port comQueueIn. More... | |
void | comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition) |
Handler base-class function for input port comStatusIn. More... | |
void | run_handlerBase (FwIndexType portNum, U32 context) |
Handler base-class function for input port run. More... | |
virtual void | buffQueueIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Pre-message hook for async input port buffQueueIn. More... | |
virtual void | comQueueIn_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Pre-message hook for async input port comQueueIn. More... | |
virtual void | comStatusIn_preMsgHook (FwIndexType portNum, Fw::Success &condition) |
Pre-message hook for async input port comStatusIn. More... | |
virtual void | run_preMsgHook (FwIndexType portNum, U32 context) |
Pre-message hook for async input port run. More... | |
virtual void | buffQueueIn_overflowHook (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
Overflow hook for async input port buffQueueIn. More... | |
void | buffQueueSend_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port buffQueueSend. More... | |
void | comQueueSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Invoke output port comQueueSend. More... | |
void | deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port deallocate. More... | |
void | log_WARNING_HI_QueueOverflow (Svc::QueueType queueType, U32 index) const |
void | tlmWrite_comQueueDepth (const Svc::ComQueueDepth &arg, Fw::Time _tlmTime=Fw::Time()) const |
void | tlmWrite_buffQueueDepth (const Svc::BuffQueueDepth &arg, Fw::Time _tlmTime=Fw::Time()) const |
Fw::Time | getTime () |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Friends | |
class | ComQueueComponentBaseFriend |
Friend class for white-box testing. More... | |
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 More... | |
![]() | |
Os::Queue | m_queue |
queue object for active component More... | |
Auto-generated base for ComQueue component.
Component used to queue buffer types
Definition at line 36 of file ComQueueComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_BUFFQUEUEIN_INPUT_PORTS | |
NUM_COMQUEUEIN_INPUT_PORTS | |
NUM_COMSTATUSIN_INPUT_PORTS | |
NUM_RUN_INPUT_PORTS |
Definition at line 54 of file ComQueueComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_LOG_OUTPUT_PORTS | |
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_TIME_OUTPUT_PORTS | |
NUM_TLM_OUTPUT_PORTS |
Definition at line 62 of file ComQueueComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_BUFFQUEUESEND_OUTPUT_PORTS | |
NUM_COMQUEUESEND_OUTPUT_PORTS | |
NUM_DEALLOCATE_OUTPUT_PORTS |
Definition at line 70 of file ComQueueComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_QUEUEOVERFLOW | Queue overflow event. |
Definition at line 77 of file ComQueueComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_COMQUEUEDEPTH | Channel ID for comQueueDepth. |
CHANNELID_BUFFQUEUEDEPTH | Channel ID for buffQueueDepth. |
Definition at line 82 of file ComQueueComponentAc.hpp.
|
protected |
Construct ComQueueComponentBase object.
compName | The component name |
Definition at line 606 of file ComQueueComponentAc.cpp.
|
protectedvirtual |
Destroy ComQueueComponentBase object.
Definition at line 613 of file ComQueueComponentAc.cpp.
|
protectedpure virtual |
Handler for input port buffQueueIn.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port buffQueueIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 796 of file ComQueueComponentAc.cpp.
|
protectedpure virtual |
Overflow hook for async input port buffQueueIn.
portNum | The port number |
fwBuffer | The buffer |
|
protectedvirtual |
Pre-message hook for async input port buffQueueIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1040 of file ComQueueComponentAc.cpp.
|
protected |
Invoke output port buffQueueSend.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1081 of file ComQueueComponentAc.cpp.
|
protectedpure virtual |
Handler for input port comQueueIn.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
|
protected |
Handler base-class function for input port comQueueIn.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 854 of file ComQueueComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port comQueueIn.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 1049 of file ComQueueComponentAc.cpp.
|
protected |
Invoke output port comQueueSend.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 1096 of file ComQueueComponentAc.cpp.
|
protectedpure virtual |
Handler for input port comStatusIn.
portNum | The port number |
condition | Condition success/failure |
|
protected |
Handler base-class function for input port comStatusIn.
portNum | The port number |
condition | Condition success/failure |
Definition at line 921 of file ComQueueComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port comStatusIn.
portNum | The port number |
condition | Condition success/failure |
Definition at line 1059 of file ComQueueComponentAc.cpp.
|
protected |
Invoke output port deallocate.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1113 of file ComQueueComponentAc.cpp.
Fw::InputBufferSendPort * Svc::ComQueueComponentBase::get_buffQueueIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 330 of file ComQueueComponentAc.cpp.
Fw::InputComPort * Svc::ComQueueComponentBase::get_comQueueIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 341 of file ComQueueComponentAc.cpp.
Fw::InputSuccessConditionPort * Svc::ComQueueComponentBase::get_comStatusIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 352 of file ComQueueComponentAc.cpp.
Svc::InputSchedPort * Svc::ComQueueComponentBase::get_run_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 363 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of buffQueueIn input ports
Definition at line 623 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of buffQueueSend output ports
Definition at line 683 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of comQueueIn input ports
Definition at line 629 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of comQueueSend output ports
Definition at line 689 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of comStatusIn input ports
Definition at line 635 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of deallocate output ports
Definition at line 695 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 651 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of run input ports
Definition at line 641 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 667 of file ComQueueComponentAc.cpp.
|
protected |
Get the number of Tlm output ports
Definition at line 673 of file ComQueueComponentAc.cpp.
|
protected |
void Svc::ComQueueComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize ComQueueComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 75 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port buffQueueSend is connected
portNum | The port number |
Definition at line 757 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port comQueueSend is connected
portNum | The port number |
Definition at line 768 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port deallocate is connected
portNum | The port number |
Definition at line 779 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 705 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 731 of file ComQueueComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
portNum | The port number |
Definition at line 742 of file ComQueueComponentAc.cpp.
|
protected |
Log event QueueOverflow
Queue overflow event
queueType | The Queue data type |
index | index of overflowed queue |
Definition at line 1132 of file ComQueueComponentAc.cpp.
|
protectedpure virtual |
Handler for input port run.
portNum | The port number |
context | The call order |
|
protected |
Handler base-class function for input port run.
portNum | The port number |
context | The call order |
Definition at line 974 of file ComQueueComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port run.
portNum | The port number |
context | The call order |
Definition at line 1068 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_buffQueueSend_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to buffQueueSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 442 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_comQueueSend_OutputPort | ( | FwIndexType | portNum, |
Fw::InputComPort * | port | ||
) |
Connect port to comQueueSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 456 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_deallocate_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to deallocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 470 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_Log_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to Log[portNum].
portNum | The port number |
port | The input port |
Definition at line 378 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_Time_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to Time[portNum].
portNum | The port number |
port | The input port |
Definition at line 410 of file ComQueueComponentAc.cpp.
void Svc::ComQueueComponentBase::set_Tlm_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to Tlm[portNum].
portNum | The port number |
port | The input port |
Definition at line 424 of file ComQueueComponentAc.cpp.
|
protected |
Write telemetry channel buffQueueDepth
Depth of queues of Fw::Buffer type
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1274 of file ComQueueComponentAc.cpp.
|
protected |
Write telemetry channel comQueueDepth
Depth of queues of Fw::ComBuffer type
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1241 of file ComQueueComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 45 of file ComQueueComponentAc.hpp.