Class AlertableCollection.MultiAlertInfo

java.lang.Object

com.ctre.phoenix6.alerts.AlertableCollection.MultiAlertInfo

Enclosing class:

AlertableCollection

public static final class AlertableCollection.MultiAlertInfo
extends Object

Information about a multi-level alert.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	isActive	Whether the multi-level alert is active.
final PhoenixAlert.Level	level	The new alert urgency level.
final String	text	The new text to report in the alert, or null to leave the text unchanged.

Method Summary

Modifier and Type	Method	Description
static AlertableCollection.MultiAlertInfo	active(PhoenixAlert.Level level)	Creates new information for an active multi-level alert without changing the alert text.
static AlertableCollection.MultiAlertInfo	active(PhoenixAlert.Level level, String text)	Creates new information for an active multi-level alert.
static AlertableCollection.MultiAlertInfo	inactive()	Gets information for an inactive multi-level alert.

Methods inherited from class Object

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

Field Details

isActive

public final boolean isActive

Whether the multi-level alert is active.

level

public final PhoenixAlert.Level level

The new alert urgency level.

text

public final String text

The new text to report in the alert, or null to leave the text unchanged.

Method Details

inactive

public static AlertableCollection.MultiAlertInfo inactive()

Gets information for an inactive multi-level alert.

Returns:

Information for an inactive multi-level alert

active

public static AlertableCollection.MultiAlertInfo active(PhoenixAlert.Level level)

Creates new information for an active multi-level alert without changing the alert text.

Parameters:

level - New alert urgency level

Returns:

Information for an active multi-level alert without changing the alert text

active

public static AlertableCollection.MultiAlertInfo active(PhoenixAlert.Level level,
 String text)

Creates new information for an active multi-level alert.

Parameters:

level - New alert urgency level

text - New text to report in the alert, or null to leave the text unchanged

Returns:

Information for an active multi-level alert