F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::ComQueueComponentBase Class Referenceabstract

Auto-generated base for ComQueue component. More...

#include <Svc/ComQueue/ComQueueComponentAc.hpp>

Inheritance diagram for Svc::ComQueueComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::ComQueue

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize ComQueueComponentBase object.
 
Fw::InputBufferSendPortget_buffQueueIn_InputPort (FwIndexType portNum)
 
Fw::InputComPortget_comQueueIn_InputPort (FwIndexType portNum)
 
Fw::InputSuccessConditionPortget_comStatusIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_run_InputPort (FwIndexType portNum)
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum].
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum].
 
void set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to Tlm[portNum].
 
void set_buffQueueSend_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to buffQueueSend[portNum].
 
void set_comQueueSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
 Connect port to comQueueSend[portNum].
 
void set_deallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to deallocate[portNum].
 
- 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
 
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.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

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...
 
- Protected Types inherited from Fw::ActiveComponentBase
enum  Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
 Tracks the lifecycle of the component. More...
 

Protected Member Functions

 ComQueueComponentBase (const char *compName="")
 Construct ComQueueComponentBase object.
 
virtual ~ComQueueComponentBase ()
 Destroy ComQueueComponentBase object.
 
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.
 
virtual void comQueueIn_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
 Handler for input port comQueueIn.
 
virtual void comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0
 Handler for input port comStatusIn.
 
virtual void run_handler (FwIndexType portNum, U32 context)=0
 Handler for input port run.
 
void buffQueueIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port buffQueueIn.
 
void comQueueIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Handler base-class function for input port comQueueIn.
 
void comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
 Handler base-class function for input port comStatusIn.
 
void run_handlerBase (FwIndexType portNum, U32 context)
 Handler base-class function for input port run.
 
virtual void buffQueueIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Pre-message hook for async input port buffQueueIn.
 
virtual void comQueueIn_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Pre-message hook for async input port comQueueIn.
 
virtual void comStatusIn_preMsgHook (FwIndexType portNum, Fw::Success &condition)
 Pre-message hook for async input port comStatusIn.
 
virtual void run_preMsgHook (FwIndexType portNum, U32 context)
 Pre-message hook for async input port run.
 
virtual void buffQueueIn_overflowHook (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
 Overflow hook for async input port buffQueueIn.
 
void buffQueueSend_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port buffQueueSend.
 
void comQueueSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Invoke output port comQueueSend.
 
void deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port deallocate.
 
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 ()
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 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.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 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
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 

Friends

class ComQueueComponentBaseFriend
 Friend class for white-box testing.
 

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
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component
 

Detailed Description

Auto-generated base for ComQueue component.

Component used to queue buffer types

Definition at line 36 of file ComQueueComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_QUEUEOVERFLOW 

Queue overflow event.

Definition at line 77 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_COMQUEUEDEPTH 

Channel ID for comQueueDepth.

CHANNELID_BUFFQUEUEDEPTH 

Channel ID for buffQueueDepth.

Definition at line 82 of file ComQueueComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComQueueComponentBase()

Svc::ComQueueComponentBase::ComQueueComponentBase ( const char *  compName = "")
protected

Construct ComQueueComponentBase object.

Parameters
compNameThe component name

Definition at line 605 of file ComQueueComponentAc.cpp.

◆ ~ComQueueComponentBase()

Svc::ComQueueComponentBase::~ComQueueComponentBase ( )
protectedvirtual

Destroy ComQueueComponentBase object.

Definition at line 612 of file ComQueueComponentAc.cpp.

Member Function Documentation

◆ buffQueueIn_handler()

virtual void Svc::ComQueueComponentBase::buffQueueIn_handler ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port buffQueueIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ buffQueueIn_handlerBase()

void Svc::ComQueueComponentBase::buffQueueIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port buffQueueIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 795 of file ComQueueComponentAc.cpp.

◆ buffQueueIn_overflowHook()

virtual void Svc::ComQueueComponentBase::buffQueueIn_overflowHook ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Overflow hook for async input port buffQueueIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ buffQueueIn_preMsgHook()

void Svc::ComQueueComponentBase::buffQueueIn_preMsgHook ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedvirtual

Pre-message hook for async input port buffQueueIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1039 of file ComQueueComponentAc.cpp.

◆ buffQueueSend_out()

void Svc::ComQueueComponentBase::buffQueueSend_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port buffQueueSend.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1080 of file ComQueueComponentAc.cpp.

◆ comQueueIn_handler()

virtual void Svc::ComQueueComponentBase::comQueueIn_handler ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protectedpure virtual

Handler for input port comQueueIn.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

◆ comQueueIn_handlerBase()

void Svc::ComQueueComponentBase::comQueueIn_handlerBase ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protected

Handler base-class function for input port comQueueIn.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 853 of file ComQueueComponentAc.cpp.

◆ comQueueIn_preMsgHook()

void Svc::ComQueueComponentBase::comQueueIn_preMsgHook ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protectedvirtual

Pre-message hook for async input port comQueueIn.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 1048 of file ComQueueComponentAc.cpp.

◆ comQueueSend_out()

void Svc::ComQueueComponentBase::comQueueSend_out ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protected

Invoke output port comQueueSend.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 1095 of file ComQueueComponentAc.cpp.

◆ comStatusIn_handler()

virtual void Svc::ComQueueComponentBase::comStatusIn_handler ( FwIndexType  portNum,
Fw::Success condition 
)
protectedpure virtual

Handler for input port comStatusIn.

Parameters
portNumThe port number
conditionCondition success/failure

◆ comStatusIn_handlerBase()

void Svc::ComQueueComponentBase::comStatusIn_handlerBase ( FwIndexType  portNum,
Fw::Success condition 
)
protected

Handler base-class function for input port comStatusIn.

Parameters
portNumThe port number
conditionCondition success/failure

Definition at line 920 of file ComQueueComponentAc.cpp.

◆ comStatusIn_preMsgHook()

void Svc::ComQueueComponentBase::comStatusIn_preMsgHook ( FwIndexType  portNum,
Fw::Success condition 
)
protectedvirtual

Pre-message hook for async input port comStatusIn.

Parameters
portNumThe port number
conditionCondition success/failure

Definition at line 1058 of file ComQueueComponentAc.cpp.

◆ deallocate_out()

void Svc::ComQueueComponentBase::deallocate_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port deallocate.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1112 of file ComQueueComponentAc.cpp.

◆ get_buffQueueIn_InputPort()

Fw::InputBufferSendPort * Svc::ComQueueComponentBase::get_buffQueueIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
buffQueueIn[portNum]
Parameters
portNumThe port number

Definition at line 329 of file ComQueueComponentAc.cpp.

◆ get_comQueueIn_InputPort()

Fw::InputComPort * Svc::ComQueueComponentBase::get_comQueueIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
comQueueIn[portNum]
Parameters
portNumThe port number

Definition at line 340 of file ComQueueComponentAc.cpp.

◆ get_comStatusIn_InputPort()

Fw::InputSuccessConditionPort * Svc::ComQueueComponentBase::get_comStatusIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
comStatusIn[portNum]
Parameters
portNumThe port number

Definition at line 351 of file ComQueueComponentAc.cpp.

◆ get_run_InputPort()

Svc::InputSchedPort * Svc::ComQueueComponentBase::get_run_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
run[portNum]
Parameters
portNumThe port number

Definition at line 362 of file ComQueueComponentAc.cpp.

◆ getNum_buffQueueIn_InputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_buffQueueIn_InputPorts ( ) const
protected

Get the number of buffQueueIn input ports

Returns
The number of buffQueueIn input ports

Definition at line 622 of file ComQueueComponentAc.cpp.

◆ getNum_buffQueueSend_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_buffQueueSend_OutputPorts ( ) const
protected

Get the number of buffQueueSend output ports

Returns
The number of buffQueueSend output ports

Definition at line 682 of file ComQueueComponentAc.cpp.

◆ getNum_comQueueIn_InputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_comQueueIn_InputPorts ( ) const
protected

Get the number of comQueueIn input ports

Returns
The number of comQueueIn input ports

Definition at line 628 of file ComQueueComponentAc.cpp.

◆ getNum_comQueueSend_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_comQueueSend_OutputPorts ( ) const
protected

Get the number of comQueueSend output ports

Returns
The number of comQueueSend output ports

Definition at line 688 of file ComQueueComponentAc.cpp.

◆ getNum_comStatusIn_InputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_comStatusIn_InputPorts ( ) const
protected

Get the number of comStatusIn input ports

Returns
The number of comStatusIn input ports

Definition at line 634 of file ComQueueComponentAc.cpp.

◆ getNum_deallocate_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_deallocate_OutputPorts ( ) const
protected

Get the number of deallocate output ports

Returns
The number of deallocate output ports

Definition at line 694 of file ComQueueComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 650 of file ComQueueComponentAc.cpp.

◆ getNum_run_InputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_run_InputPorts ( ) const
protected

Get the number of run input ports

Returns
The number of run input ports

Definition at line 640 of file ComQueueComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 666 of file ComQueueComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

FwIndexType Svc::ComQueueComponentBase::getNum_Tlm_OutputPorts ( ) const
protected

Get the number of Tlm output ports

Returns
The number of Tlm output ports

Definition at line 672 of file ComQueueComponentAc.cpp.

◆ getTime()

Fw::Time Svc::ComQueueComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1310 of file ComQueueComponentAc.cpp.

◆ init()

void Svc::ComQueueComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize ComQueueComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 74 of file ComQueueComponentAc.cpp.

◆ isConnected_buffQueueSend_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_buffQueueSend_OutputPort ( FwIndexType  portNum)
protected

Check whether port buffQueueSend is connected

Returns
Whether port buffQueueSend is connected
Parameters
portNumThe port number

Definition at line 756 of file ComQueueComponentAc.cpp.

◆ isConnected_comQueueSend_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_comQueueSend_OutputPort ( FwIndexType  portNum)
protected

Check whether port comQueueSend is connected

Returns
Whether port comQueueSend is connected
Parameters
portNumThe port number

Definition at line 767 of file ComQueueComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_deallocate_OutputPort ( FwIndexType  portNum)
protected

Check whether port deallocate is connected

Returns
Whether port deallocate is connected
Parameters
portNumThe port number

Definition at line 778 of file ComQueueComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 704 of file ComQueueComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 730 of file ComQueueComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_Tlm_OutputPort ( FwIndexType  portNum)
protected

Check whether port Tlm is connected

Returns
Whether port Tlm is connected
Parameters
portNumThe port number

Definition at line 741 of file ComQueueComponentAc.cpp.

◆ log_WARNING_HI_QueueOverflow()

void Svc::ComQueueComponentBase::log_WARNING_HI_QueueOverflow ( Svc::QueueType  queueType,
U32  index 
) const
protected

Log event QueueOverflow

Queue overflow event

Parameters
queueTypeThe Queue data type
indexindex of overflowed queue

Definition at line 1131 of file ComQueueComponentAc.cpp.

◆ run_handler()

virtual void Svc::ComQueueComponentBase::run_handler ( FwIndexType  portNum,
U32  context 
)
protectedpure virtual

Handler for input port run.

Parameters
portNumThe port number
contextThe call order

◆ run_handlerBase()

void Svc::ComQueueComponentBase::run_handlerBase ( FwIndexType  portNum,
U32  context 
)
protected

Handler base-class function for input port run.

Parameters
portNumThe port number
contextThe call order

Definition at line 973 of file ComQueueComponentAc.cpp.

◆ run_preMsgHook()

void Svc::ComQueueComponentBase::run_preMsgHook ( FwIndexType  portNum,
U32  context 
)
protectedvirtual

Pre-message hook for async input port run.

Parameters
portNumThe port number
contextThe call order

Definition at line 1067 of file ComQueueComponentAc.cpp.

◆ set_buffQueueSend_OutputPort()

void Svc::ComQueueComponentBase::set_buffQueueSend_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to buffQueueSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 441 of file ComQueueComponentAc.cpp.

◆ set_comQueueSend_OutputPort()

void Svc::ComQueueComponentBase::set_comQueueSend_OutputPort ( FwIndexType  portNum,
Fw::InputComPort port 
)

Connect port to comQueueSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 455 of file ComQueueComponentAc.cpp.

◆ set_deallocate_OutputPort()

void Svc::ComQueueComponentBase::set_deallocate_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to deallocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 469 of file ComQueueComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::ComQueueComponentBase::set_Log_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 377 of file ComQueueComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::ComQueueComponentBase::set_Time_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 409 of file ComQueueComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::ComQueueComponentBase::set_Tlm_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to Tlm[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 423 of file ComQueueComponentAc.cpp.

◆ tlmWrite_buffQueueDepth()

void Svc::ComQueueComponentBase::tlmWrite_buffQueueDepth ( const Svc::BuffQueueDepth arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel buffQueueDepth

Depth of queues of Fw::Buffer type

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1273 of file ComQueueComponentAc.cpp.

◆ tlmWrite_comQueueDepth()

void Svc::ComQueueComponentBase::tlmWrite_comQueueDepth ( const Svc::ComQueueDepth arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel comQueueDepth

Depth of queues of Fw::ComBuffer type

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1240 of file ComQueueComponentAc.cpp.

Friends And Related Symbol Documentation

◆ ComQueueComponentBaseFriend

friend class ComQueueComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 45 of file ComQueueComponentAc.hpp.


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