![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for TlmPacketizer component. More...
#include <Svc/TlmPacketizer/TlmPacketizerComponentAc.hpp>
Public Member Functions | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize TlmPacketizerComponentBase object. | |
Fw::InputCmdPort * | get_cmdIn_InputPort (FwIndexType portNum) |
Svc::InputSchedPort * | get_Run_InputPort (FwIndexType portNum) |
Fw::InputTlmPort * | get_TlmRecv_InputPort (FwIndexType portNum) |
Svc::InputPingPort * | get_pingIn_InputPort (FwIndexType portNum) |
void | set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
Connect port to cmdRegOut[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_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port) |
Connect port to PktSend[portNum]. | |
void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
Connect port to pingOut[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 | |
TlmPacketizerComponentBase (const char *compName="") | |
Construct TlmPacketizerComponentBase object. | |
virtual | ~TlmPacketizerComponentBase () |
Destroy TlmPacketizerComponentBase object. | |
FwIndexType | getNum_cmdIn_InputPorts () const |
FwIndexType | getNum_Run_InputPorts () const |
FwIndexType | getNum_TlmRecv_InputPorts () const |
FwIndexType | getNum_pingIn_InputPorts () const |
FwIndexType | getNum_cmdRegOut_OutputPorts () const |
FwIndexType | getNum_cmdResponseOut_OutputPorts () const |
FwIndexType | getNum_eventOut_OutputPorts () const |
FwIndexType | getNum_timeGetOut_OutputPorts () const |
FwIndexType | getNum_tlmOut_OutputPorts () const |
FwIndexType | getNum_PktSend_OutputPorts () const |
FwIndexType | getNum_pingOut_OutputPorts () const |
bool | isConnected_cmdRegOut_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_PktSend_OutputPort (FwIndexType portNum) |
bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
virtual void | Run_handler (FwIndexType portNum, U32 context)=0 |
Handler for input port Run. | |
virtual void | TlmRecv_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0 |
Handler for input port TlmRecv. | |
virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
Handler for input port pingIn. | |
void | Run_handlerBase (FwIndexType portNum, U32 context) |
Handler base-class function for input port Run. | |
void | TlmRecv_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val) |
Handler base-class function for input port TlmRecv. | |
void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
Handler base-class function for input port pingIn. | |
virtual void | Run_preMsgHook (FwIndexType portNum, U32 context) |
Pre-message hook for async input port Run. | |
virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
Pre-message hook for async input port pingIn. | |
void | PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Invoke output port PktSend. | |
void | pingOut_out (FwIndexType portNum, U32 key) |
Invoke output port pingOut. | |
void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
Emit command response. | |
virtual void | SET_LEVEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 level)=0 |
virtual void | SEND_PKT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 id)=0 |
void | SET_LEVEL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | SEND_PKT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | SET_LEVEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command SET_LEVEL. | |
virtual void | SEND_PKT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command SEND_PKT. | |
void | log_WARNING_LO_NoChan (U32 Id) const |
void | log_ACTIVITY_HI_LevelSet (U32 id) const |
void | log_WARNING_LO_MaxLevelExceed (U32 level, U32 max) const |
void | log_ACTIVITY_LO_PacketSent (U32 id) const |
void | log_WARNING_LO_PacketNotFound (U32 id) const |
void | tlmWrite_SendLevel (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
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 | TlmPacketizerComponentBaseFriend |
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 TlmPacketizer component.
A component for storing telemetry
Definition at line 36 of file TlmPacketizerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDIN_INPUT_PORTS |
Definition at line 54 of file TlmPacketizerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_RUN_INPUT_PORTS | |
NUM_TLMRECV_INPUT_PORTS | |
NUM_PINGIN_INPUT_PORTS |
Definition at line 59 of file TlmPacketizerComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_CMDREGOUT_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 66 of file TlmPacketizerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_PKTSEND_OUTPUT_PORTS | |
NUM_PINGOUT_OUTPUT_PORTS |
Definition at line 76 of file TlmPacketizerComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_SET_LEVEL | Set telemetry send level. |
OPCODE_SEND_PKT | Force a packet to be sent. |
Definition at line 82 of file TlmPacketizerComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 88 of file TlmPacketizerComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_SENDLEVEL | Channel ID for SendLevel. |
Definition at line 97 of file TlmPacketizerComponentAc.hpp.
|
protected |
Construct TlmPacketizerComponentBase object.
compName | The component name |
Definition at line 673 of file TlmPacketizerComponentAc.cpp.
|
protectedvirtual |
Destroy TlmPacketizerComponentBase object.
Definition at line 680 of file TlmPacketizerComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 1079 of file TlmPacketizerComponentAc.cpp.
Fw::InputCmdPort * Svc::TlmPacketizerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
portNum | The port number |
Definition at line 347 of file TlmPacketizerComponentAc.cpp.
Svc::InputPingPort * Svc::TlmPacketizerComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 384 of file TlmPacketizerComponentAc.cpp.
Svc::InputSchedPort * Svc::TlmPacketizerComponentBase::get_Run_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 362 of file TlmPacketizerComponentAc.cpp.
Fw::InputTlmPort * Svc::TlmPacketizerComponentBase::get_TlmRecv_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 373 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 690 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 722 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 728 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of eventOut output ports
Definition at line 734 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 712 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 772 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of PktSend output ports
Definition at line 766 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of Run input ports
Definition at line 700 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of timeGetOut output ports
Definition at line 750 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 756 of file TlmPacketizerComponentAc.cpp.
|
protected |
Get the number of TlmRecv input ports
Definition at line 706 of file TlmPacketizerComponentAc.cpp.
|
protected |
void Svc::TlmPacketizerComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize TlmPacketizerComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 73 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
portNum | The port number |
Definition at line 782 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
portNum | The port number |
Definition at line 793 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
portNum | The port number |
Definition at line 804 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
portNum | The port number |
Definition at line 867 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port PktSend is connected
portNum | The port number |
Definition at line 856 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port timeGetOut is connected
portNum | The port number |
Definition at line 830 of file TlmPacketizerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
portNum | The port number |
Definition at line 841 of file TlmPacketizerComponentAc.cpp.
|
protected |
Log event LevelSet
Telemetry send level set
id | The level |
Definition at line 1330 of file TlmPacketizerComponentAc.cpp.
|
protected |
Log event PacketSent
Packet manually sent
id | The packet ID |
Definition at line 1514 of file TlmPacketizerComponentAc.cpp.
|
protected |
Log event MaxLevelExceed
Telemetry send level set
level | The level |
max | The max packet level |
Definition at line 1412 of file TlmPacketizerComponentAc.cpp.
|
protected |
Log event NoChan
Telemetry channel is not part of a telemetry packet.
Id | The telemetry ID |
Definition at line 1248 of file TlmPacketizerComponentAc.cpp.
|
protected |
Log event PacketNotFound
Couldn't find the packet to send
id | The packet ID |
Definition at line 1596 of file TlmPacketizerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 960 of file TlmPacketizerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 1030 of file TlmPacketizerComponentAc.cpp.
|
protected |
Invoke output port pingOut.
portNum | The port number |
key | Value to return to pinger |
Definition at line 1060 of file TlmPacketizerComponentAc.cpp.
|
protected |
Invoke output port PktSend.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 1043 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 655 of file TlmPacketizerComponentAc.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 884 of file TlmPacketizerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port Run.
portNum | The port number |
context | The call order |
Definition at line 1021 of file TlmPacketizerComponentAc.cpp.
|
protectedpure virtual |
Handler for command SEND_PKT
Force a packet to be sent
opCode | The opcode |
cmdSeq | The command sequence number |
id | The packet ID |
|
protected |
Base-class handler function for command SEND_PKT
Force a packet to be sent
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 1155 of file TlmPacketizerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command SEND_PKT.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1233 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdRegPort * | port | ||
) |
Connect port to cmdRegOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 399 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdResponsePort * | port | ||
) |
Connect port to cmdResponseOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 413 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_eventOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to eventOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 427 of file TlmPacketizerComponentAc.cpp.
|
protectedpure virtual |
Handler for command SET_LEVEL
Set telemetry send level
opCode | The opcode |
cmdSeq | The command sequence number |
level | The I32 command argument |
|
protected |
Base-class handler function for command SET_LEVEL
Set telemetry send level
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 1096 of file TlmPacketizerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command SET_LEVEL.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1222 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
Svc::InputPingPort * | port | ||
) |
Connect port to pingOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 505 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_PktSend_OutputPort | ( | FwIndexType | portNum, |
Fw::InputComPort * | port | ||
) |
Connect port to PktSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 491 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_timeGetOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to timeGetOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 459 of file TlmPacketizerComponentAc.cpp.
void Svc::TlmPacketizerComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to tlmOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 473 of file TlmPacketizerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port TlmRecv.
portNum | The port number |
id | Telemetry Channel ID |
timeTag | Time Tag |
val | Buffer containing serialized telemetry value |
|
protected |
Handler base-class function for input port TlmRecv.
portNum | The port number |
id | Telemetry Channel ID |
timeTag | Time Tag |
val | Buffer containing serialized telemetry value |
Definition at line 937 of file TlmPacketizerComponentAc.cpp.
|
protected |
Write telemetry channel SendLevel
Telemetry send level
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1682 of file TlmPacketizerComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 45 of file TlmPacketizerComponentAc.hpp.