F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
Health component implementation class. More...
#include <Svc/Health/HealthComponentImpl.hpp>
Classes | |
struct | PingEntry |
struct for ping entry More... | |
Public Member Functions | |
HealthImpl (const char *const compName) | |
HealthImpl constructor. More... | |
void | init (const FwSizeType queueDepth, const NATIVE_INT_TYPE instance) |
HealthImpl initialization function. More... | |
void | setPingEntries (PingEntry *pingEntries, NATIVE_INT_TYPE numPingEntries, U32 watchDogCode) |
Set ping entry tables. More... | |
~HealthImpl () | |
Component destructor. More... | |
Public Member Functions inherited from Svc::HealthComponentBase | |
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 |
Health component implementation class.
The health component iterates through each entry in its table and checks its status. If a ping entry tracker is enabled, it will ping its corresponding port with a provided key. If a ping return is outstanding, a counter is decremented, and its value is checked against warning and fault thresholds. A watchdog is always stroked in the run handler.
Definition at line 32 of file HealthComponentImpl.hpp.
Svc::HealthImpl::HealthImpl | ( | const char *const | compName | ) |
HealthImpl constructor.
The constructor for Health
compName | component name |
Definition at line 23 of file HealthComponentImpl.cpp.
Svc::HealthImpl::~HealthImpl | ( | ) |
Component destructor.
The destructor for HealthImpl is empty
Definition at line 67 of file HealthComponentImpl.cpp.
|
protectedvirtual |
additional checks function
Does additional checks based on the platform
Definition at line 24 of file HealthComponentStubChecks.cpp.
void Svc::HealthImpl::init | ( | const FwSizeType | queueDepth, |
const NATIVE_INT_TYPE | instance | ||
) |
HealthImpl initialization function.
Initializes the autocoded base class, ping table, and data members
queueDepth | Depth of queue |
instance | The instance number |
Definition at line 39 of file HealthComponentImpl.cpp.
void Svc::HealthImpl::setPingEntries | ( | PingEntry * | pingEntries, |
NATIVE_INT_TYPE | numPingEntries, | ||
U32 | watchDogCode | ||
) |
Set ping entry tables.
Provides a table of ping entries
pingEntries | Pointer to provided ping table entries |
numPingEntries | Number of ping entries in table |
watchDogCode | Value that is sent to watchdog |
Definition at line 45 of file HealthComponentImpl.cpp.