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

#include <Svc/Health/HealthComponentAc.hpp>

Inheritance diagram for Svc::HealthComponentBase:

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 FwIdType)
	Set the ID base. More...

FwIdType	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. More...

virtual	~HealthComponentBase ()
	Destroy HealthComponentBase object. More...

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. More...

virtual void	Run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port Run. More...

void	PingReturn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port PingReturn. More...

void	Run_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port Run. More...

virtual void	PingReturn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port PingReturn. More...

void	PingSend_out (FwIndexType portNum, U32 key)
	Invoke output port PingSend. More...

void	WdogStroke_out (FwIndexType portNum, U32 code)
	Invoke output port WdogStroke. More...

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...

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. More...

virtual void	HLTH_PING_ENABLE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command HLTH_PING_ENABLE. More...

virtual void	HLTH_CHNG_PING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command HLTH_CHNG_PING. More...

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 () const

virtual MsgDispatchStatus	doDispatch ()
	Called in the message loop to dispatch a message from the queue. More...

MsgDispatchStatus	dispatchCurrentMessages ()
	Dispatch all current messages unless ERROR or EXIT occurs. More...

Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...

virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

FwSizeType	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 (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	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...

Static Protected Member Functions
static constexpr FwIndexType	getNum_CmdDisp_InputPorts ()

static constexpr FwIndexType	getNum_PingReturn_InputPorts ()

static constexpr FwIndexType	getNum_Run_InputPorts ()

static constexpr FwIndexType	getNum_CmdReg_OutputPorts ()

static constexpr FwIndexType	getNum_CmdStatus_OutputPorts ()

static constexpr FwIndexType	getNum_Log_OutputPorts ()

static constexpr FwIndexType	getNum_Time_OutputPorts ()

static constexpr FwIndexType	getNum_Tlm_OutputPorts ()

static constexpr FwIndexType	getNum_PingSend_OutputPorts ()

static constexpr FwIndexType	getNum_WdogStroke_OutputPorts ()

Friends
class	HealthTesterBase
	Friend class tester to support autocoded test harness. More...

class	HealthTester
	Friend class tester implementation to support 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...

Detailed Description

Auto-generated base for Health component.

A component for checking the health of active components

Definition at line 39 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 59 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 64 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 70 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 80 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 86 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 93 of file HealthComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_PINGLATEWARNINGS	Channel ID for PingLateWarnings.

Definition at line 105 of file HealthComponentAc.hpp.

Constructor & Destructor Documentation

◆ HealthComponentBase()

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

protected

Construct HealthComponentBase object.

Parameters

compName The component name

Definition at line 642 of file HealthComponentAc.cpp.

◆ ~HealthComponentBase()

Svc::HealthComponentBase::~HealthComponentBase ( )

protectedvirtual

Destroy HealthComponentBase object.

Definition at line 649 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

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 898 of file HealthComponentAc.cpp.

◆ dispatchCurrentMessages()

Fw::QueuedComponentBase::MsgDispatchStatus Svc::HealthComponentBase::dispatchCurrentMessages ( )

protected

Dispatch all current messages unless ERROR or EXIT occurs.

Definition at line 2246 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 1929 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

portNum The port number

Definition at line 323 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

portNum The port number

Definition at line 338 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

portNum The port number

Definition at line 349 of file HealthComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_CmdDisp_InputPorts ( )

inlinestaticprotected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 324 of file HealthComponentAc.hpp.

◆ getNum_CmdReg_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_CmdReg_OutputPorts ( )

inlinestaticprotected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 357 of file HealthComponentAc.hpp.

◆ getNum_CmdStatus_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_CmdStatus_OutputPorts ( )

inlinestaticprotected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 364 of file HealthComponentAc.hpp.

◆ getNum_Log_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_Log_OutputPorts ( )

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 371 of file HealthComponentAc.hpp.

◆ getNum_PingReturn_InputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_PingReturn_InputPorts ( )

inlinestaticprotected

Get the number of PingReturn input ports

Returns: The number of PingReturn input ports

Definition at line 337 of file HealthComponentAc.hpp.

◆ getNum_PingSend_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_PingSend_OutputPorts ( )

inlinestaticprotected

Get the number of PingSend output ports

Returns: The number of PingSend output ports

Definition at line 409 of file HealthComponentAc.hpp.

◆ getNum_Run_InputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_Run_InputPorts ( )

inlinestaticprotected

Get the number of Run input ports

Returns: The number of Run input ports

Definition at line 344 of file HealthComponentAc.hpp.

◆ getNum_Time_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_Time_OutputPorts ( )

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 389 of file HealthComponentAc.hpp.

◆ getNum_Tlm_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_Tlm_OutputPorts ( )

inlinestaticprotected

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 396 of file HealthComponentAc.hpp.

◆ getNum_WdogStroke_OutputPorts()

static constexpr FwIndexType Svc::HealthComponentBase::getNum_WdogStroke_OutputPorts ( )

inlinestaticprotected

Get the number of WdogStroke output ports

Returns: The number of WdogStroke output ports

Definition at line 416 of file HealthComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 1912 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

opCode	The opcode
cmdSeq	The command sequence number
entry	The entry to modify
warningValue	Ping warning threshold
fatalValue	Ping 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1033 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1122 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

opCode	The opcode
cmdSeq	The command sequence number
enable	whether 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 915 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1100 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

opCode	The opcode
cmdSeq	The command sequence number
entry	The entry to enable/disable
enable	whether 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 974 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1111 of file HealthComponentAc.cpp.

◆ init()

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

Initialize HealthComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 73 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

portNum The port number

Definition at line 659 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

portNum The port number

Definition at line 670 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

portNum The port number

Definition at line 681 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

portNum The port number

Definition at line 733 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

portNum The port number

Definition at line 707 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

portNum The port number

Definition at line 718 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

portNum The port number

Definition at line 744 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

enabled If health checking is enabled

Definition at line 1399 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

enabled	If health pinging is enabled for a particular entry
entry	The entry passing the warning level

Definition at line 1484 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

entry	The entry changed
warn	The new warning value
fatal	The new FATAL value

Definition at line 1651 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

entry The entry passing the warning level

Definition at line 1209 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

entry	The entry passing the warning level
badKey	The incorrect key value

Definition at line 1294 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

entry	The entry changed
warn	The new warning value
fatal	The new FATAL value

Definition at line 1761 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

entry The entry passing the warning level

Definition at line 1137 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

entry The entry passing the warning level

Definition at line 1579 of file HealthComponentAc.cpp.

◆ PingReturn_handler()

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

protectedpure virtual

Handler for input port PingReturn.

Parameters

portNum	The port number
key	Value 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

portNum	The port number
key	Value to return to pinger

Definition at line 761 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

portNum	The port number
key	Value to return to pinger

Definition at line 841 of file HealthComponentAc.cpp.

◆ PingSend_out()

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

protected

Invoke output port PingSend.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 854 of file HealthComponentAc.cpp.

◆ regCommands()

void Svc::HealthComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 620 of file HealthComponentAc.cpp.

◆ Run_handler()

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

protectedpure virtual

Handler for input port Run.

Parameters

portNum	The port number
context	The call order

◆ Run_handlerBase()

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

protected

Handler base-class function for input port Run.

Parameters

portNum	The port number
context	The call order

Definition at line 814 of file HealthComponentAc.cpp.

◆ set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 364 of file HealthComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 378 of file HealthComponentAc.cpp.

◆ set_Log_OutputPort()

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

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 392 of file HealthComponentAc.cpp.

◆ set_PingSend_OutputPort()

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

Connect port to PingSend[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 456 of file HealthComponentAc.cpp.

◆ set_Time_OutputPort()

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

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 424 of file HealthComponentAc.cpp.

◆ set_Tlm_OutputPort()

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

Connect port to Tlm[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 438 of file HealthComponentAc.cpp.

◆ set_WdogStroke_OutputPort()

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

Connect port to WdogStroke[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 470 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

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1875 of file HealthComponentAc.cpp.

◆ WdogStroke_out()

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

protected

Invoke output port WdogStroke.

Parameters

portNum	The port number
code	Watchdog stroke code

Definition at line 874 of file HealthComponentAc.cpp.

Friends And Related Function Documentation

◆ HealthTester

friend class HealthTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 50 of file HealthComponentAc.hpp.

◆ HealthTesterBase

friend class HealthTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 48 of file HealthComponentAc.hpp.

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

Svc/Health/HealthComponentAc.hpp
Svc/Health/HealthComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ HealthComponentBase()

◆ ~HealthComponentBase()

Member Function Documentation

◆ cmdResponse_out()

◆ dispatchCurrentMessages()

◆ doDispatch()

◆ get_CmdDisp_InputPort()

◆ get_PingReturn_InputPort()

◆ get_Run_InputPort()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_PingReturn_InputPorts()

◆ getNum_PingSend_OutputPorts()

◆ getNum_Run_InputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ getNum_WdogStroke_OutputPorts()

◆ getTime()

◆ HLTH_CHNG_PING_cmdHandler()

◆ HLTH_CHNG_PING_cmdHandlerBase()

◆ HLTH_CHNG_PING_preMsgHook()

◆ HLTH_ENABLE_cmdHandler()

◆ HLTH_ENABLE_cmdHandlerBase()

◆ HLTH_ENABLE_preMsgHook()

◆ HLTH_PING_ENABLE_cmdHandler()

◆ HLTH_PING_ENABLE_cmdHandlerBase()

◆ HLTH_PING_ENABLE_preMsgHook()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_PingSend_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ isConnected_WdogStroke_OutputPort()

◆ log_ACTIVITY_HI_HLTH_CHECK_ENABLE()

◆ log_ACTIVITY_HI_HLTH_CHECK_PING()

◆ log_ACTIVITY_HI_HLTH_PING_UPDATED()

◆ log_FATAL_HLTH_PING_LATE()

◆ log_FATAL_HLTH_PING_WRONG_KEY()

◆ log_WARNING_HI_HLTH_PING_INVALID_VALUES()

◆ log_WARNING_HI_HLTH_PING_WARN()

◆ log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR()

◆ PingReturn_handler()

◆ PingReturn_handlerBase()

◆ PingReturn_preMsgHook()

◆ PingSend_out()

◆ regCommands()

◆ Run_handler()

◆ Run_handlerBase()

◆ set_CmdReg_OutputPort()

◆ set_CmdStatus_OutputPort()

◆ set_Log_OutputPort()

◆ set_PingSend_OutputPort()

◆ set_Time_OutputPort()

◆ set_Tlm_OutputPort()

◆ set_WdogStroke_OutputPort()

◆ tlmWrite_PingLateWarnings()

◆ WdogStroke_out()

Friends And Related Function Documentation

◆ HealthTester

◆ HealthTesterBase