Class AlertableCollection.AlertInfo

java.lang.Object

com.ctre.phoenix6.alerts.AlertableCollection.AlertInfo

Enclosing class:

AlertableCollection

public static final class AlertableCollection.AlertInfo
extends Object

Information about an alert.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	isActive	Whether the alert is active.
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.AlertInfo	active()	Gets information for an active alert without changing the alert text.
static AlertableCollection.AlertInfo	active(String text)	Creates new information for an active alert.
static AlertableCollection.AlertInfo	inactive()	Gets information for an inactive 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 alert is active.

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.AlertInfo inactive()

Gets information for an inactive alert.

Returns:

Information for an inactive alert

active

public static AlertableCollection.AlertInfo active()

Gets information for an active alert without changing the alert text.

Returns:

Information for an active alert without changing the alert text

active

public static AlertableCollection.AlertInfo active(String text)

Creates new information for an active alert.

Parameters:

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

Returns:

Information for an active alert