Class FaultLogger

java.lang.Object

dev.doglog.internal.FaultLogger

public class FaultLogger
extends Object

Provides the interface for logging faults. Faults are a DogLog concept that were created prior to WPILib alerts. Alerts are great but are NT only, so faults allow DogLog to provide a simple interface to logging errors that writes to both NT and DataLog.

Method Summary

Modifier and Type	Method	Description
static void	addFault(LogWriterHighLevel logger, String faultName)
static void	addFault(LogWriterHighLevel logger, String faultName, @Nullable Alert.AlertType alertType)	Log a fault.
static void	clearFault(LogWriterHighLevel logger, String faultName)
static void	decreaseFault(LogWriterHighLevel logger, String faultName)	Remove the alert associated with a fault.
static boolean	faultsActive()
static boolean	faultsLogged()

Methods inherited from class Object

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

Method Details

addFault

public static void addFault(LogWriterHighLevel logger,
 String faultName)

addFault

public static void addFault(LogWriterHighLevel logger,
 String faultName,
 @Nullable Alert.AlertType alertType)

Log a fault.

Parameters:

logger - LogConsumer to use.

faultName - The name of the fault to log.

alertType - The type of alert to create for the fault, or null if it should not create an alert

decreaseFault

public static void decreaseFault(LogWriterHighLevel logger,
 String faultName)

Remove the alert associated with a fault.

Parameters:

logger - LogConsumer to use.

faultName - The name of the fault to remove.

clearFault

public static void clearFault(LogWriterHighLevel logger,
 String faultName)

faultsLogged

public static boolean faultsLogged()

faultsActive

public static boolean faultsActive()