 |
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
|
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/TlmPacketizer/TlmPacketizer.hpp>
Public Member Functions | |
| TlmPacketizer (const char *const compName) | |
| void | setPacketList (const TlmPacketizerPacketList &packetList, const Svc::TlmPacketizerPacket &ignoreList, const NATIVE_UINT_TYPE startLevel) |
| ~TlmPacketizer (void) | |
 Public Member Functions inherited from Svc::TlmPacketizerComponentBase | |
| void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
| Initialize TlmPacketizerComponentBase object. More... | |
| 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]. More... | |
| void | set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
| Connect port to cmdResponseOut[portNum]. More... | |
| void | set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
| Connect port to eventOut[portNum]. More... | |
| void | set_timeGetOut_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
| Connect port to timeGetOut[portNum]. More... | |
| void | set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
| Connect port to tlmOut[portNum]. More... | |
| void | set_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port) |
| Connect port to PktSend[portNum]. More... | |
| void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
| Connect port to pingOut[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. More... | |
| 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 More... | |
| void | exit () |
| exit task in active component More... | |
| Os::Task::Status | join () |
| Join the thread. More... | |
| DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
| Join to thread with discarded value_ptr. More... | |
| Public Member Functions inherited from Fw::PassiveComponentBase | |
| void | setIdBase (const U32) |
| Set the ID base. More... | |
| U32 | getIdBase () const |
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 Types inherited from Svc::TlmPacketizerComponentBase | |
| enum | { NUM_CMDIN_INPUT_PORTS = 1 } |
| Enumerations for numbers of special input ports. More... | |
| enum | { NUM_RUN_INPUT_PORTS = 1 , NUM_TLMRECV_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 } |
| Enumerations for numbers of typed input ports. More... | |
| enum | { NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1 , NUM_TIMEGETOUT_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of special output ports. More... | |
| enum | { NUM_PKTSEND_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of typed output ports. More... | |
| enum | { OPCODE_SET_LEVEL = 0x0 , OPCODE_SEND_PKT = 0x1 } |
| Command opcodes. More... | |
| enum | { EVENTID_NOCHAN = 0x0 , EVENTID_LEVELSET = 0x1 , EVENTID_MAXLEVELEXCEED = 0x2 , EVENTID_PACKETSENT = 0x3 , EVENTID_PACKETNOTFOUND = 0x4 } |
| Event IDs. More... | |
| enum | { CHANNELID_SENDLEVEL = 0x0 } |
| 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 inherited from Svc::TlmPacketizerComponentBase | |
| TlmPacketizerComponentBase (const char *compName="") | |
| Construct TlmPacketizerComponentBase object. More... | |
| virtual | ~TlmPacketizerComponentBase () |
| Destroy TlmPacketizerComponentBase object. More... | |
| 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) |
| void | Run_handlerBase (FwIndexType portNum, U32 context) |
| Handler base-class function for input port Run. More... | |
| void | TlmRecv_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val) |
| Handler base-class function for input port TlmRecv. More... | |
| void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
| Handler base-class function for input port pingIn. More... | |
| virtual void | Run_preMsgHook (FwIndexType portNum, U32 context) |
| Pre-message hook for async input port Run. More... | |
| virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
| Pre-message hook for async input port pingIn. More... | |
| void | PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
| Invoke output port PktSend. More... | |
| void | pingOut_out (FwIndexType portNum, U32 key) |
| Invoke output port pingOut. More... | |
| void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
| Emit command response. More... | |
| 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. More... | |
| virtual void | SEND_PKT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command SEND_PKT. More... | |
| void | log_WARNING_LO_NoChan (U32 Id) |
| void | log_ACTIVITY_HI_LevelSet (U32 id) |
| void | log_WARNING_LO_MaxLevelExceed (U32 level, U32 max) |
| void | log_ACTIVITY_LO_PacketSent (U32 id) |
| void | log_WARNING_LO_PacketNotFound (U32 id) |
| void | tlmWrite_SendLevel (U32 arg, Fw::Time _tlmTime=Fw::Time()) |
| Fw::Time | getTime () |
| Protected Member Functions inherited from Fw::ActiveComponentBase | |
| 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... | |
| Protected Member Functions inherited from Fw::QueuedComponentBase | |
| 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... | |
| Protected Member Functions inherited from Fw::PassiveComponentBase | |
| 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 |
| Protected Member Functions inherited from Fw::ObjBase | |
| ObjBase (const char *name) | |
| ObjBase constructor. More... | |
| virtual | ~ObjBase () |
| Destructor. More... | |
| void | init () |
| Object initializer. More... | |
| 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... | |
Definition at line 21 of file TlmPacketizer.hpp.
| Svc::TlmPacketizer::TlmPacketizer | ( | const char *const | compName | ) |
Construct object TlmPacketizer
| compName | The component name |
Definition at line 21 of file TlmPacketizer.cpp.
| Svc::TlmPacketizer::~TlmPacketizer | ( | void | ) |
Destroy object TlmPacketizer
Definition at line 50 of file TlmPacketizer.cpp.
| void Svc::TlmPacketizer::setPacketList | ( | const TlmPacketizerPacketList & | packetList, |
| const Svc::TlmPacketizerPacket & | ignoreList, | ||
| const NATIVE_UINT_TYPE | startLevel | ||
| ) |
Definition at line 52 of file TlmPacketizer.cpp.
1.9.1