F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for Health component. More...
#include <Svc/Health/HealthComponentAc.hpp>
Public Member Functions | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize HealthComponentBase object. More... | |
Fw::InputCmdPort * | get_CmdDisp_InputPort (FwIndexType portNum) |
Svc::InputPingPort * | get_PingReturn_InputPort (FwIndexType portNum) |
Svc::InputSchedPort * | get_Run_InputPort (FwIndexType portNum) |
void | set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
Connect port to CmdReg[portNum]. More... | |
void | set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
Connect port to CmdStatus[portNum]. More... | |
void | set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
Connect port to Log[portNum]. More... | |
void | set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
Connect port to Time[portNum]. More... | |
void | set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
Connect port to Tlm[portNum]. More... | |
void | set_PingSend_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
Connect port to PingSend[portNum]. More... | |
void | set_WdogStroke_OutputPort (FwIndexType portNum, Svc::InputWatchDogPort *port) |
Connect port to WdogStroke[portNum]. More... | |
void | regCommands () |
Register commands with the Command Dispatcher. More... | |
Public Member Functions inherited from Fw::PassiveComponentBase | |
void | setIdBase (const U32) |
Set the ID base. More... | |
U32 | getIdBase () const |
Friends | |
class | HealthComponentBaseFriend |
Friend class for white-box testing. More... | |
Additional Inherited Members | |
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::QueuedComponentBase | |
Os::Queue | m_queue |
queue object for active component More... | |
Auto-generated base for Health component.
A component for checking the health of active components
Definition at line 37 of file HealthComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDDISP_INPUT_PORTS |
Definition at line 55 of file HealthComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_PINGRETURN_INPUT_PORTS | |
NUM_RUN_INPUT_PORTS |
Definition at line 60 of file HealthComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_CMDREG_OUTPUT_PORTS | |
NUM_CMDSTATUS_OUTPUT_PORTS | |
NUM_LOG_OUTPUT_PORTS | |
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_TIME_OUTPUT_PORTS | |
NUM_TLM_OUTPUT_PORTS |
Definition at line 66 of file HealthComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_PINGSEND_OUTPUT_PORTS | |
NUM_WDOGSTROKE_OUTPUT_PORTS |
Definition at line 76 of file HealthComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_HLTH_ENABLE | A command to enable or disable health checks. |
OPCODE_HLTH_PING_ENABLE | Ignore a particular ping entry. |
OPCODE_HLTH_CHNG_PING | Change ping value. |
Definition at line 82 of file HealthComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 89 of file HealthComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_PINGLATEWARNINGS | Channel ID for PingLateWarnings. |
Definition at line 101 of file HealthComponentAc.hpp.
|
protected |
Construct HealthComponentBase object.
compName | The component name |
Definition at line 639 of file HealthComponentAc.cpp.
|
protectedvirtual |
Destroy HealthComponentBase object.
Definition at line 646 of file HealthComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 971 of file HealthComponentAc.cpp.
|
protectedvirtual |
Called in the message loop to dispatch a message from the queue.
Implements Fw::QueuedComponentBase.
Definition at line 2002 of file HealthComponentAc.cpp.
Fw::InputCmdPort * Svc::HealthComponentBase::get_CmdDisp_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
portNum | The port number |
Definition at line 320 of file HealthComponentAc.cpp.
Svc::InputPingPort * Svc::HealthComponentBase::get_PingReturn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 335 of file HealthComponentAc.cpp.
Svc::InputSchedPort * Svc::HealthComponentBase::get_Run_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 346 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdDisp input ports
Definition at line 656 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdReg output ports
Definition at line 682 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdStatus output ports
Definition at line 688 of file HealthComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 694 of file HealthComponentAc.cpp.
|
protected |
Get the number of PingReturn input ports
Definition at line 666 of file HealthComponentAc.cpp.
|
protected |
Get the number of PingSend output ports
Definition at line 726 of file HealthComponentAc.cpp.
|
protected |
Get the number of Run input ports
Definition at line 672 of file HealthComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 710 of file HealthComponentAc.cpp.
|
protected |
Get the number of Tlm output ports
Definition at line 716 of file HealthComponentAc.cpp.
|
protected |
Get the number of WdogStroke output ports
Definition at line 732 of file HealthComponentAc.cpp.
|
protected |
|
protectedpure virtual |
Handler for command HLTH_CHNG_PING
Change ping value
opCode | The opcode |
cmdSeq | The command sequence number |
entry | The entry to modify |
warningValue | Ping warning threshold |
fatalValue | Ping fatal threshold |
|
protected |
Base-class handler function for command HLTH_CHNG_PING
Change ping value
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 1106 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_CHNG_PING.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1195 of file HealthComponentAc.cpp.
|
protectedpure virtual |
Handler for command HLTH_ENABLE
A command to enable or disable health checks
opCode | The opcode |
cmdSeq | The command sequence number |
enable | whether or not health checks are enabled |
|
protected |
Base-class handler function for command HLTH_ENABLE
A command to enable or disable health checks
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 988 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_ENABLE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1173 of file HealthComponentAc.cpp.
|
protectedpure virtual |
Handler for command HLTH_PING_ENABLE
Ignore a particular ping entry
opCode | The opcode |
cmdSeq | The command sequence number |
entry | The entry to enable/disable |
enable | whether or not a port is pinged |
|
protected |
Base-class handler function for command HLTH_PING_ENABLE
Ignore a particular ping entry
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 1047 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_PING_ENABLE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1184 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize HealthComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 71 of file HealthComponentAc.cpp.
|
protected |
Check whether port CmdReg is connected
portNum | The port number |
Definition at line 742 of file HealthComponentAc.cpp.
|
protected |
Check whether port CmdStatus is connected
portNum | The port number |
Definition at line 753 of file HealthComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 764 of file HealthComponentAc.cpp.
|
protected |
Check whether port PingSend is connected
portNum | The port number |
Definition at line 816 of file HealthComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 790 of file HealthComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
portNum | The port number |
Definition at line 801 of file HealthComponentAc.cpp.
|
protected |
Check whether port WdogStroke is connected
portNum | The port number |
Definition at line 827 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_CHECK_ENABLE
Report checking turned on or off
enabled | If health checking is enabled |
Definition at line 1472 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_CHECK_PING
Report a particular entry on or off
enabled | If health pinging is enabled for a particular entry |
entry | The entry passing the warning level |
Definition at line 1557 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_PING_UPDATED
Report changed ping
entry | The entry changed |
warn | The new warning value |
fatal | The new FATAL value |
Definition at line 1724 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_PING_LATE
Declare FATAL since task is no longer responding
entry | The entry passing the warning level |
Definition at line 1282 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_PING_WRONG_KEY
Declare FATAL since task is no longer responding
entry | The entry passing the warning level |
badKey | The incorrect key value |
Definition at line 1367 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_PING_INVALID_VALUES
Report changed ping
entry | The entry changed |
warn | The new warning value |
fatal | The new FATAL value |
Definition at line 1834 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_PING_WARN
Warn that a ping target is longer than the warning value
entry | The entry passing the warning level |
Definition at line 1210 of file HealthComponentAc.cpp.
|
protected |
Log event HLTH_CHECK_LOOKUP_ERROR
Entry was not found
entry | The entry passing the warning level |
Definition at line 1652 of file HealthComponentAc.cpp.
|
protectedpure virtual |
Handler for input port PingReturn.
portNum | The port number |
key | Value to return to pinger |
|
protected |
Handler base-class function for input port PingReturn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 844 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port PingReturn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 924 of file HealthComponentAc.cpp.
|
protected |
Invoke output port PingSend.
portNum | The port number |
key | Value to return to pinger |
Definition at line 937 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 617 of file HealthComponentAc.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 897 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_CmdReg_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdRegPort * | port | ||
) |
Connect port to CmdReg[portNum].
portNum | The port number |
port | The input port |
Definition at line 361 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_CmdStatus_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdResponsePort * | port | ||
) |
Connect port to CmdStatus[portNum].
portNum | The port number |
port | The input port |
Definition at line 375 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_Log_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to Log[portNum].
portNum | The port number |
port | The input port |
Definition at line 389 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_PingSend_OutputPort | ( | FwIndexType | portNum, |
Svc::InputPingPort * | port | ||
) |
Connect port to PingSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 453 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_Time_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to Time[portNum].
portNum | The port number |
port | The input port |
Definition at line 421 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_Tlm_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to Tlm[portNum].
portNum | The port number |
port | The input port |
Definition at line 435 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::set_WdogStroke_OutputPort | ( | FwIndexType | portNum, |
Svc::InputWatchDogPort * | port | ||
) |
Connect port to WdogStroke[portNum].
portNum | The port number |
port | The input port |
Definition at line 467 of file HealthComponentAc.cpp.
|
protected |
Write telemetry channel PingLateWarnings
Number of overrun warnings
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1948 of file HealthComponentAc.cpp.
|
protected |
Invoke output port WdogStroke.
portNum | The port number |
code | Watchdog stroke code |
Definition at line 952 of file HealthComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 46 of file HealthComponentAc.hpp.