Package com.lightningrobotics.common.fault

Class FaultMonitor

java.lang.Object

com.lightningrobotics.common.fault.AbstractFaultMonitor

com.lightningrobotics.common.fault.FaultMonitor

public class FaultMonitor
extends AbstractFaultMonitor

Basic implementation of an AbstractFaultMonitor that also provides a means to register ad check other fault monitors

Field Summary

Fields inherited from class com.lightningrobotics.common.fault.AbstractFaultMonitor

code, fatal, msg

Constructor Summary

Constructors

Constructor	Description
FaultMonitor(LightningFaultCodes.Code code, java.util.function.BooleanSupplier fn)
FaultMonitor(LightningFaultCodes.Code code, java.util.function.BooleanSupplier fn, java.lang.String msg)
FaultMonitor(LightningFaultCodes.Code code, java.util.function.BooleanSupplier fn, java.lang.String msg, boolean fatal)

Method Summary

Modifier and Type	Method	Description
boolean	checkFault()	To be overridden, determines if fault should be written
static void	checkMonitors()	Checks all fault monitors
static void	register(AbstractFaultMonitor fm)	Adds a new fault monitor to be checked with checkMonitors()

Methods inherited from class com.lightningrobotics.common.fault.AbstractFaultMonitor

check, trigger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaultMonitor

public FaultMonitor(LightningFaultCodes.Code code,
                    java.util.function.BooleanSupplier fn,
                    java.lang.String msg,
                    boolean fatal)

FaultMonitor

public FaultMonitor(LightningFaultCodes.Code code,
                    java.util.function.BooleanSupplier fn,
                    java.lang.String msg)

FaultMonitor

public FaultMonitor(LightningFaultCodes.Code code,
                    java.util.function.BooleanSupplier fn)

Method Detail

register

public static void register(AbstractFaultMonitor fm)

Adds a new fault monitor to be checked with checkMonitors()

Parameters:

fm - The AbstractFaultMonitor to be registered

checkMonitors

public static void checkMonitors()

Checks all fault monitors

checkFault

public boolean checkFault()

Description copied from class: AbstractFaultMonitor

To be overridden, determines if fault should be written

Specified by:

checkFault in class AbstractFaultMonitor

Returns:

True if the fault should be written, false otherwise