Class AlertableCollection

java.lang.Object

com.ctre.phoenix6.alerts.AlertableCollection

public class AlertableCollection
extends Object

Collection of objects that can report alerts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AlertableCollection.AlertInfo	Information about an alert.
static final class	AlertableCollection.MultiAlertInfo	Information about a multi-level alert.

Constructor Summary

Constructors

Constructor	Description
AlertableCollection(String group)	Constructs a new collection of alertable objects.

Method Summary

Modifier and Type	Method	Description
final void	report()	Reports all alerts in this collection.
final AlertableCollection	withAlert(String id, PhoenixAlert.Level level, Supplier<AlertableCollection.AlertInfo> infoGetter)	Adds a PhoenixAlert to this collection.
final AlertableCollection	withAlert(String id, PhoenixAlert.Level level, Supplier<AlertableCollection.AlertInfo> infoGetter, String text)	Adds a PhoenixAlert to this collection.
final AlertableCollection	withAlert(String id, PhoenixAlert.Level level, Supplier<AlertableCollection.AlertInfo> infoGetter, String text, double debounceSeconds)	Adds a PhoenixAlert to this collection.
final AlertableCollection	withAlertable(PhoenixAlertable alertable)	Adds a PhoenixAlertable to this collection.
final AlertableCollection	withBeforeAlerts(Runnable func)	Adds a function to run before updating any alerts.
final AlertableCollection	withMultiAlert(String id, long levelFlags, Supplier<AlertableCollection.MultiAlertInfo> infoGetter)	Adds a PhoenixMultiAlert to this collection.
final AlertableCollection	withMultiAlert(String id, long levelFlags, Supplier<AlertableCollection.MultiAlertInfo> infoGetter, String text)	Adds a PhoenixMultiAlert to this collection.
final AlertableCollection	withMultiAlert(String id, long levelFlags, Supplier<AlertableCollection.MultiAlertInfo> infoGetter, String text, double debounceSeconds)	Adds a PhoenixMultiAlert to this collection.

Methods inherited from class Object

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

Constructor Details

AlertableCollection

public AlertableCollection(String group)

Constructs a new collection of alertable objects.

Parameters:

group - Alert group identifier

Method Details

report

public final void report()

Reports all alerts in this collection.

withAlertable

public final AlertableCollection withAlertable(PhoenixAlertable alertable)

Adds a PhoenixAlertable to this collection.

Parameters:

alertable - PhoenixAlertable to register

Returns:

This collection

withAlert

public final AlertableCollection withAlert(String id,
 PhoenixAlert.Level level,
 Supplier<AlertableCollection.AlertInfo> infoGetter)

Adds a PhoenixAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

level - Alert urgency level

infoGetter - Function returning the AlertableCollection.AlertInfo to report

Returns:

This collection

withAlert

public final AlertableCollection withAlert(String id,
 PhoenixAlert.Level level,
 Supplier<AlertableCollection.AlertInfo> infoGetter,
 String text)

Adds a PhoenixAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

level - Alert urgency level

infoGetter - Function returning the AlertableCollection.AlertInfo to report

text - Default alert text to display when the alert is active

Returns:

This collection

withAlert

public final AlertableCollection withAlert(String id,
 PhoenixAlert.Level level,
 Supplier<AlertableCollection.AlertInfo> infoGetter,
 String text,
 double debounceSeconds)

Adds a PhoenixAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

level - Alert urgency level

infoGetter - Function returning the AlertableCollection.AlertInfo to report

text - Default alert text to display when the alert is active

debounceSeconds - Debounce time of the alert in seconds, or negative to use the default debounce time (1 second)

Returns:

This collection

withMultiAlert

public final AlertableCollection withMultiAlert(String id,
 long levelFlags,
 Supplier<AlertableCollection.MultiAlertInfo> infoGetter)

Adds a PhoenixMultiAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

levelFlags - Alert urgency levels to include

infoGetter - Function returning the AlertableCollection.MultiAlertInfo to report

Returns:

This collection

withMultiAlert

public final AlertableCollection withMultiAlert(String id,
 long levelFlags,
 Supplier<AlertableCollection.MultiAlertInfo> infoGetter,
 String text)

Adds a PhoenixMultiAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

levelFlags - Alert urgency levels to include

infoGetter - Function returning the AlertableCollection.MultiAlertInfo to report

text - Default alert text to display when the alert is active

Returns:

This collection

withMultiAlert

public final AlertableCollection withMultiAlert(String id,
 long levelFlags,
 Supplier<AlertableCollection.MultiAlertInfo> infoGetter,
 String text,
 double debounceSeconds)

Adds a PhoenixMultiAlert to this collection.

Parameters:

id - Alert identifier, unique within the group

levelFlags - Alert urgency levels to include

infoGetter - Function returning the AlertableCollection.MultiAlertInfo to report

text - Default alert text to display when the alert is active

debounceSeconds - Debounce time of the alert in seconds, or negative to use the default debounce time (1 second)

Returns:

This collection

withBeforeAlerts

public final AlertableCollection withBeforeAlerts(Runnable func)

Adds a function to run before updating any alerts. This can be used to perform actions such as a bulk signal refresh so individual alerts do not have to perform refreshes.

Parameters:

func - Runnable to run before any alerts

Returns:

This collection