![]() |
F´ Flight Software - C/C++ Documentation
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. | |
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]. | |
void | set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
Connect port to CmdStatus[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_PingSend_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
Connect port to PingSend[portNum]. | |
void | set_WdogStroke_OutputPort (FwIndexType portNum, Svc::InputWatchDogPort *port) |
Connect port to WdogStroke[portNum]. | |
void | regCommands () |
Register commands with the Command Dispatcher. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
Protected Member Functions | |
HealthComponentBase (const char *compName="") | |
Construct HealthComponentBase object. | |
virtual | ~HealthComponentBase () |
Destroy HealthComponentBase object. | |
FwIndexType | getNum_CmdDisp_InputPorts () const |
FwIndexType | getNum_PingReturn_InputPorts () const |
FwIndexType | getNum_Run_InputPorts () const |
FwIndexType | getNum_CmdReg_OutputPorts () const |
FwIndexType | getNum_CmdStatus_OutputPorts () const |
FwIndexType | getNum_Log_OutputPorts () const |
FwIndexType | getNum_Time_OutputPorts () const |
FwIndexType | getNum_Tlm_OutputPorts () const |
FwIndexType | getNum_PingSend_OutputPorts () const |
FwIndexType | getNum_WdogStroke_OutputPorts () const |
bool | isConnected_CmdReg_OutputPort (FwIndexType portNum) |
bool | isConnected_CmdStatus_OutputPort (FwIndexType portNum) |
bool | isConnected_Log_OutputPort (FwIndexType portNum) |
bool | isConnected_Time_OutputPort (FwIndexType portNum) |
bool | isConnected_Tlm_OutputPort (FwIndexType portNum) |
bool | isConnected_PingSend_OutputPort (FwIndexType portNum) |
bool | isConnected_WdogStroke_OutputPort (FwIndexType portNum) |
virtual void | PingReturn_handler (FwIndexType portNum, U32 key)=0 |
Handler for input port PingReturn. | |
virtual void | Run_handler (FwIndexType portNum, U32 context)=0 |
Handler for input port Run. | |
void | PingReturn_handlerBase (FwIndexType portNum, U32 key) |
Handler base-class function for input port PingReturn. | |
void | Run_handlerBase (FwIndexType portNum, U32 context) |
Handler base-class function for input port Run. | |
virtual void | PingReturn_preMsgHook (FwIndexType portNum, U32 key) |
Pre-message hook for async input port PingReturn. | |
void | PingSend_out (FwIndexType portNum, U32 key) |
Invoke output port PingSend. | |
void | WdogStroke_out (FwIndexType portNum, U32 code) |
Invoke output port WdogStroke. | |
void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
Emit command response. | |
virtual void | HLTH_ENABLE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Fw::Enabled enable)=0 |
virtual void | HLTH_PING_ENABLE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &entry, Fw::Enabled enable)=0 |
virtual void | HLTH_CHNG_PING_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &entry, U32 warningValue, U32 fatalValue)=0 |
void | HLTH_ENABLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | HLTH_PING_ENABLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | HLTH_CHNG_PING_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | HLTH_ENABLE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command HLTH_ENABLE. | |
virtual void | HLTH_PING_ENABLE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command HLTH_PING_ENABLE. | |
virtual void | HLTH_CHNG_PING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command HLTH_CHNG_PING. | |
void | log_WARNING_HI_HLTH_PING_WARN (const Fw::StringBase &entry) const |
void | log_FATAL_HLTH_PING_LATE (const Fw::StringBase &entry) const |
void | log_FATAL_HLTH_PING_WRONG_KEY (const Fw::StringBase &entry, U32 badKey) const |
void | log_ACTIVITY_HI_HLTH_CHECK_ENABLE (Fw::Enabled enabled) const |
void | log_ACTIVITY_HI_HLTH_CHECK_PING (Fw::Enabled enabled, const Fw::StringBase &entry) const |
void | log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR (const Fw::StringBase &entry) const |
void | log_ACTIVITY_HI_HLTH_PING_UPDATED (const Fw::StringBase &entry, U32 warn, U32 fatal) const |
void | log_WARNING_HI_HLTH_PING_INVALID_VALUES (const Fw::StringBase &entry, U32 warn, U32 fatal) const |
void | tlmWrite_PingLateWarnings (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
Fw::Time | getTime () |
virtual MsgDispatchStatus | doDispatch () |
Called in the message loop to dispatch a message from the queue. | |
![]() | |
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 | HealthComponentBaseFriend |
Friend class for white-box testing. | |
Additional Inherited Members | |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT } |
![]() | |
Os::Queue | m_queue |
queue object for active component | |
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 641 of file HealthComponentAc.cpp.
|
protectedvirtual |
Destroy HealthComponentBase object.
Definition at line 648 of file HealthComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 973 of file HealthComponentAc.cpp.
|
protectedvirtual |
Called in the message loop to dispatch a message from the queue.
Implements Fw::QueuedComponentBase.
Definition at line 2004 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 322 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 337 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 348 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdDisp input ports
Definition at line 658 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdReg output ports
Definition at line 684 of file HealthComponentAc.cpp.
|
protected |
Get the number of CmdStatus output ports
Definition at line 690 of file HealthComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 696 of file HealthComponentAc.cpp.
|
protected |
Get the number of PingReturn input ports
Definition at line 668 of file HealthComponentAc.cpp.
|
protected |
Get the number of PingSend output ports
Definition at line 728 of file HealthComponentAc.cpp.
|
protected |
Get the number of Run input ports
Definition at line 674 of file HealthComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 712 of file HealthComponentAc.cpp.
|
protected |
Get the number of Tlm output ports
Definition at line 718 of file HealthComponentAc.cpp.
|
protected |
Get the number of WdogStroke output ports
Definition at line 734 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 1108 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_CHNG_PING.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1197 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 990 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_ENABLE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1175 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 1049 of file HealthComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command HLTH_PING_ENABLE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1186 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 72 of file HealthComponentAc.cpp.
|
protected |
Check whether port CmdReg is connected
portNum | The port number |
Definition at line 744 of file HealthComponentAc.cpp.
|
protected |
Check whether port CmdStatus is connected
portNum | The port number |
Definition at line 755 of file HealthComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 766 of file HealthComponentAc.cpp.
|
protected |
Check whether port PingSend is connected
portNum | The port number |
Definition at line 818 of file HealthComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 792 of file HealthComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
portNum | The port number |
Definition at line 803 of file HealthComponentAc.cpp.
|
protected |
Check whether port WdogStroke is connected
portNum | The port number |
Definition at line 829 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 1474 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 1559 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 1726 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 1284 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 1369 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 1836 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 1212 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 1654 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 846 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 926 of file HealthComponentAc.cpp.
|
protected |
Invoke output port PingSend.
portNum | The port number |
key | Value to return to pinger |
Definition at line 939 of file HealthComponentAc.cpp.
void Svc::HealthComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 619 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 899 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 363 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 377 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 391 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 455 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 423 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 437 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 469 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 1950 of file HealthComponentAc.cpp.
|
protected |
Invoke output port WdogStroke.
portNum | The port number |
code | Watchdog stroke code |
Definition at line 954 of file HealthComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 46 of file HealthComponentAc.hpp.