F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::HealthComponentBase Class Referenceabstract

Auto-generated base for Health component. More...

#include <Svc/Health/HealthComponentAc.hpp>

Inheritance diagram for Svc::HealthComponentBase:
Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::HealthImpl

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize HealthComponentBase object.
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_PingReturn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_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.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_CMDDISP_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_PINGRETURN_INPUT_PORTS = 25 , NUM_RUN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREG_OUTPUT_PORTS = 1 , NUM_CMDSTATUS_OUTPUT_PORTS = 1 , NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 ,
  NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_PINGSEND_OUTPUT_PORTS = 25 , NUM_WDOGSTROKE_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { OPCODE_HLTH_ENABLE = 0x0 , OPCODE_HLTH_PING_ENABLE = 0x1 , OPCODE_HLTH_CHNG_PING = 0x2 }
 Command opcodes. More...
 
enum  {
  EVENTID_HLTH_PING_WARN = 0x0 , EVENTID_HLTH_PING_LATE = 0x1 , EVENTID_HLTH_PING_WRONG_KEY = 0x2 , EVENTID_HLTH_CHECK_ENABLE = 0x3 ,
  EVENTID_HLTH_CHECK_PING = 0x4 , EVENTID_HLTH_CHECK_LOOKUP_ERROR = 0x5 , EVENTID_HLTH_PING_UPDATED = 0x6 , EVENTID_HLTH_PING_INVALID_VALUES = 0x7
}
 Event IDs. More...
 
enum  { CHANNELID_PINGLATEWARNINGS = 0x0 }
 Channel IDs. More...
 

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.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 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
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 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

- 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
 

Detailed Description

Auto-generated base for Health component.

A component for checking the health of active components

Definition at line 37 of file HealthComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS 

Definition at line 55 of file HealthComponentAc.hpp.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_HLTH_PING_WARN 

Warn that a ping target is longer than the warning value.

EVENTID_HLTH_PING_LATE 

Declare FATAL since task is no longer responding.

EVENTID_HLTH_PING_WRONG_KEY 

Declare FATAL since task is no longer responding.

EVENTID_HLTH_CHECK_ENABLE 

Report checking turned on or off.

EVENTID_HLTH_CHECK_PING 

Report a particular entry on or off.

EVENTID_HLTH_CHECK_LOOKUP_ERROR 

Entry was not found.

EVENTID_HLTH_PING_UPDATED 

Report changed ping.

EVENTID_HLTH_PING_INVALID_VALUES 

Report changed ping.

Definition at line 89 of file HealthComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_PINGLATEWARNINGS 

Channel ID for PingLateWarnings.

Definition at line 101 of file HealthComponentAc.hpp.

Constructor & Destructor Documentation

◆ HealthComponentBase()

Svc::HealthComponentBase::HealthComponentBase ( const char *  compName = "")
protected

Construct HealthComponentBase object.

Parameters
compNameThe component name

Definition at line 641 of file HealthComponentAc.cpp.

◆ ~HealthComponentBase()

Svc::HealthComponentBase::~HealthComponentBase ( )
protectedvirtual

Destroy HealthComponentBase object.

Definition at line 648 of file HealthComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::HealthComponentBase::cmdResponse_out ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdResponse  response 
)
protected

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 973 of file HealthComponentAc.cpp.

◆ doDispatch()

Fw::QueuedComponentBase::MsgDispatchStatus Svc::HealthComponentBase::doDispatch ( )
protectedvirtual

Called in the message loop to dispatch a message from the queue.

Implements Fw::QueuedComponentBase.

Definition at line 2004 of file HealthComponentAc.cpp.

◆ get_CmdDisp_InputPort()

Fw::InputCmdPort * Svc::HealthComponentBase::get_CmdDisp_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
CmdDisp[portNum]
Parameters
portNumThe port number

Definition at line 322 of file HealthComponentAc.cpp.

◆ get_PingReturn_InputPort()

Svc::InputPingPort * Svc::HealthComponentBase::get_PingReturn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
PingReturn[portNum]
Parameters
portNumThe port number

Definition at line 337 of file HealthComponentAc.cpp.

◆ get_Run_InputPort()

Svc::InputSchedPort * Svc::HealthComponentBase::get_Run_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
Run[portNum]
Parameters
portNumThe port number

Definition at line 348 of file HealthComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

FwIndexType Svc::HealthComponentBase::getNum_CmdDisp_InputPorts ( ) const
protected

Get the number of CmdDisp input ports

Returns
The number of CmdDisp input ports

Definition at line 658 of file HealthComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_CmdReg_OutputPorts ( ) const
protected

Get the number of CmdReg output ports

Returns
The number of CmdReg output ports

Definition at line 684 of file HealthComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_CmdStatus_OutputPorts ( ) const
protected

Get the number of CmdStatus output ports

Returns
The number of CmdStatus output ports

Definition at line 690 of file HealthComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 696 of file HealthComponentAc.cpp.

◆ getNum_PingReturn_InputPorts()

FwIndexType Svc::HealthComponentBase::getNum_PingReturn_InputPorts ( ) const
protected

Get the number of PingReturn input ports

Returns
The number of PingReturn input ports

Definition at line 668 of file HealthComponentAc.cpp.

◆ getNum_PingSend_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_PingSend_OutputPorts ( ) const
protected

Get the number of PingSend output ports

Returns
The number of PingSend output ports

Definition at line 728 of file HealthComponentAc.cpp.

◆ getNum_Run_InputPorts()

FwIndexType Svc::HealthComponentBase::getNum_Run_InputPorts ( ) const
protected

Get the number of Run input ports

Returns
The number of Run input ports

Definition at line 674 of file HealthComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 712 of file HealthComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_Tlm_OutputPorts ( ) const
protected

Get the number of Tlm output ports

Returns
The number of Tlm output ports

Definition at line 718 of file HealthComponentAc.cpp.

◆ getNum_WdogStroke_OutputPorts()

FwIndexType Svc::HealthComponentBase::getNum_WdogStroke_OutputPorts ( ) const
protected

Get the number of WdogStroke output ports

Returns
The number of WdogStroke output ports

Definition at line 734 of file HealthComponentAc.cpp.

◆ getTime()

Fw::Time Svc::HealthComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1987 of file HealthComponentAc.cpp.

◆ HLTH_CHNG_PING_cmdHandler()

virtual void Svc::HealthComponentBase::HLTH_CHNG_PING_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg entry,
U32  warningValue,
U32  fatalValue 
)
protectedpure virtual

Handler for command HLTH_CHNG_PING

Change ping value

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
entryThe entry to modify
warningValuePing warning threshold
fatalValuePing fatal threshold

◆ HLTH_CHNG_PING_cmdHandlerBase()

void Svc::HealthComponentBase::HLTH_CHNG_PING_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command HLTH_CHNG_PING

Change ping value

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1108 of file HealthComponentAc.cpp.

◆ HLTH_CHNG_PING_preMsgHook()

void Svc::HealthComponentBase::HLTH_CHNG_PING_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command HLTH_CHNG_PING.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1197 of file HealthComponentAc.cpp.

◆ HLTH_ENABLE_cmdHandler()

virtual void Svc::HealthComponentBase::HLTH_ENABLE_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::Enabled  enable 
)
protectedpure virtual

Handler for command HLTH_ENABLE

A command to enable or disable health checks

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
enablewhether or not health checks are enabled

◆ HLTH_ENABLE_cmdHandlerBase()

void Svc::HealthComponentBase::HLTH_ENABLE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command HLTH_ENABLE

A command to enable or disable health checks

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 990 of file HealthComponentAc.cpp.

◆ HLTH_ENABLE_preMsgHook()

void Svc::HealthComponentBase::HLTH_ENABLE_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command HLTH_ENABLE.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1175 of file HealthComponentAc.cpp.

◆ HLTH_PING_ENABLE_cmdHandler()

virtual void Svc::HealthComponentBase::HLTH_PING_ENABLE_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg entry,
Fw::Enabled  enable 
)
protectedpure virtual

Handler for command HLTH_PING_ENABLE

Ignore a particular ping entry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
entryThe entry to enable/disable
enablewhether or not a port is pinged

◆ HLTH_PING_ENABLE_cmdHandlerBase()

void Svc::HealthComponentBase::HLTH_PING_ENABLE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command HLTH_PING_ENABLE

Ignore a particular ping entry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1049 of file HealthComponentAc.cpp.

◆ HLTH_PING_ENABLE_preMsgHook()

void Svc::HealthComponentBase::HLTH_PING_ENABLE_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command HLTH_PING_ENABLE.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1186 of file HealthComponentAc.cpp.

◆ init()

void Svc::HealthComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize HealthComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 72 of file HealthComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::HealthComponentBase::isConnected_CmdReg_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdReg is connected

Returns
Whether port CmdReg is connected
Parameters
portNumThe port number

Definition at line 744 of file HealthComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::HealthComponentBase::isConnected_CmdStatus_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdStatus is connected

Returns
Whether port CmdStatus is connected
Parameters
portNumThe port number

Definition at line 755 of file HealthComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::HealthComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 766 of file HealthComponentAc.cpp.

◆ isConnected_PingSend_OutputPort()

bool Svc::HealthComponentBase::isConnected_PingSend_OutputPort ( FwIndexType  portNum)
protected

Check whether port PingSend is connected

Returns
Whether port PingSend is connected
Parameters
portNumThe port number

Definition at line 818 of file HealthComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::HealthComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 792 of file HealthComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::HealthComponentBase::isConnected_Tlm_OutputPort ( FwIndexType  portNum)
protected

Check whether port Tlm is connected

Returns
Whether port Tlm is connected
Parameters
portNumThe port number

Definition at line 803 of file HealthComponentAc.cpp.

◆ isConnected_WdogStroke_OutputPort()

bool Svc::HealthComponentBase::isConnected_WdogStroke_OutputPort ( FwIndexType  portNum)
protected

Check whether port WdogStroke is connected

Returns
Whether port WdogStroke is connected
Parameters
portNumThe port number

Definition at line 829 of file HealthComponentAc.cpp.

◆ log_ACTIVITY_HI_HLTH_CHECK_ENABLE()

void Svc::HealthComponentBase::log_ACTIVITY_HI_HLTH_CHECK_ENABLE ( Fw::Enabled  enabled) const
protected

Log event HLTH_CHECK_ENABLE

Report checking turned on or off

Parameters
enabledIf health checking is enabled

Definition at line 1474 of file HealthComponentAc.cpp.

◆ log_ACTIVITY_HI_HLTH_CHECK_PING()

void Svc::HealthComponentBase::log_ACTIVITY_HI_HLTH_CHECK_PING ( Fw::Enabled  enabled,
const Fw::StringBase entry 
) const
protected

Log event HLTH_CHECK_PING

Report a particular entry on or off

Parameters
enabledIf health pinging is enabled for a particular entry
entryThe entry passing the warning level

Definition at line 1559 of file HealthComponentAc.cpp.

◆ log_ACTIVITY_HI_HLTH_PING_UPDATED()

void Svc::HealthComponentBase::log_ACTIVITY_HI_HLTH_PING_UPDATED ( const Fw::StringBase entry,
U32  warn,
U32  fatal 
) const
protected

Log event HLTH_PING_UPDATED

Report changed ping

Parameters
entryThe entry changed
warnThe new warning value
fatalThe new FATAL value

Definition at line 1726 of file HealthComponentAc.cpp.

◆ log_FATAL_HLTH_PING_LATE()

void Svc::HealthComponentBase::log_FATAL_HLTH_PING_LATE ( const Fw::StringBase entry) const
protected

Log event HLTH_PING_LATE

Declare FATAL since task is no longer responding

Parameters
entryThe entry passing the warning level

Definition at line 1284 of file HealthComponentAc.cpp.

◆ log_FATAL_HLTH_PING_WRONG_KEY()

void Svc::HealthComponentBase::log_FATAL_HLTH_PING_WRONG_KEY ( const Fw::StringBase entry,
U32  badKey 
) const
protected

Log event HLTH_PING_WRONG_KEY

Declare FATAL since task is no longer responding

Parameters
entryThe entry passing the warning level
badKeyThe incorrect key value

Definition at line 1369 of file HealthComponentAc.cpp.

◆ log_WARNING_HI_HLTH_PING_INVALID_VALUES()

void Svc::HealthComponentBase::log_WARNING_HI_HLTH_PING_INVALID_VALUES ( const Fw::StringBase entry,
U32  warn,
U32  fatal 
) const
protected

Log event HLTH_PING_INVALID_VALUES

Report changed ping

Parameters
entryThe entry changed
warnThe new warning value
fatalThe new FATAL value

Definition at line 1836 of file HealthComponentAc.cpp.

◆ log_WARNING_HI_HLTH_PING_WARN()

void Svc::HealthComponentBase::log_WARNING_HI_HLTH_PING_WARN ( const Fw::StringBase entry) const
protected

Log event HLTH_PING_WARN

Warn that a ping target is longer than the warning value

Parameters
entryThe entry passing the warning level

Definition at line 1212 of file HealthComponentAc.cpp.

◆ log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR()

void Svc::HealthComponentBase::log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR ( const Fw::StringBase entry) const
protected

Log event HLTH_CHECK_LOOKUP_ERROR

Entry was not found

Parameters
entryThe entry passing the warning level

Definition at line 1654 of file HealthComponentAc.cpp.

◆ PingReturn_handler()

virtual void Svc::HealthComponentBase::PingReturn_handler ( FwIndexType  portNum,
U32  key 
)
protectedpure virtual

Handler for input port PingReturn.

Parameters
portNumThe port number
keyValue to return to pinger

◆ PingReturn_handlerBase()

void Svc::HealthComponentBase::PingReturn_handlerBase ( FwIndexType  portNum,
U32  key 
)
protected

Handler base-class function for input port PingReturn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 846 of file HealthComponentAc.cpp.

◆ PingReturn_preMsgHook()

void Svc::HealthComponentBase::PingReturn_preMsgHook ( FwIndexType  portNum,
U32  key 
)
protectedvirtual

Pre-message hook for async input port PingReturn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 926 of file HealthComponentAc.cpp.

◆ PingSend_out()

void Svc::HealthComponentBase::PingSend_out ( FwIndexType  portNum,
U32  key 
)
protected

Invoke output port PingSend.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 939 of file HealthComponentAc.cpp.

◆ regCommands()

void Svc::HealthComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 619 of file HealthComponentAc.cpp.

◆ Run_handler()

virtual void Svc::HealthComponentBase::Run_handler ( FwIndexType  portNum,
U32  context 
)
protectedpure virtual

Handler for input port Run.

Parameters
portNumThe port number
contextThe call order

◆ Run_handlerBase()

void Svc::HealthComponentBase::Run_handlerBase ( FwIndexType  portNum,
U32  context 
)
protected

Handler base-class function for input port Run.

Parameters
portNumThe port number
contextThe call order

Definition at line 899 of file HealthComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::HealthComponentBase::set_CmdReg_OutputPort ( FwIndexType  portNum,
Fw::InputCmdRegPort port 
)

Connect port to CmdReg[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 363 of file HealthComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::HealthComponentBase::set_CmdStatus_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to CmdStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 377 of file HealthComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::HealthComponentBase::set_Log_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 391 of file HealthComponentAc.cpp.

◆ set_PingSend_OutputPort()

void Svc::HealthComponentBase::set_PingSend_OutputPort ( FwIndexType  portNum,
Svc::InputPingPort port 
)

Connect port to PingSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 455 of file HealthComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::HealthComponentBase::set_Time_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 423 of file HealthComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::HealthComponentBase::set_Tlm_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to Tlm[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 437 of file HealthComponentAc.cpp.

◆ set_WdogStroke_OutputPort()

void Svc::HealthComponentBase::set_WdogStroke_OutputPort ( FwIndexType  portNum,
Svc::InputWatchDogPort port 
)

Connect port to WdogStroke[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 469 of file HealthComponentAc.cpp.

◆ tlmWrite_PingLateWarnings()

void Svc::HealthComponentBase::tlmWrite_PingLateWarnings ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel PingLateWarnings

Number of overrun warnings

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1950 of file HealthComponentAc.cpp.

◆ WdogStroke_out()

void Svc::HealthComponentBase::WdogStroke_out ( FwIndexType  portNum,
U32  code 
)
protected

Invoke output port WdogStroke.

Parameters
portNumThe port number
codeWatchdog stroke code

Definition at line 954 of file HealthComponentAc.cpp.

Friends And Related Symbol Documentation

◆ HealthComponentBaseFriend

friend class HealthComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 46 of file HealthComponentAc.hpp.


The documentation for this class was generated from the following files: