Package swervelib.telemetry

Class Alert

java.lang.Object

swervelib.telemetry.Alert

public class Alert
extends Object

Class for managing persistent alerts to be sent over NetworkTables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Alert.AlertType	Represents an alert's level of urgency.

Constructor Summary

Constructors

Constructor	Description
Alert(String group, String text, Alert.AlertType type)	Creates a new Alert.
Alert(String text, Alert.AlertType type)	Creates a new Alert in the default group - "Alerts".

Method Summary

Modifier and Type	Method	Description
void	set(boolean active)	Sets whether the alert should currently be displayed.
void	setText(String text)	Updates current alert text.

Methods inherited from class java.lang.Object

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

Constructor Details

Alert

public Alert(String text,
 Alert.AlertType type)

Creates a new Alert in the default group - "Alerts". If this is the first to be instantiated, the appropriate entries will be added to NetworkTables.

Parameters:

text - Text to be displayed when the alert is active.

type - Alert level specifying urgency.

Alert

public Alert(String group,
 String text,
 Alert.AlertType type)

Creates a new Alert. If this is the first to be instantiated in its group, the appropriate entries will be added to NetworkTables.

Parameters:

group - Group identifier, also used as NetworkTables title

text - Text to be displayed when the alert is active.

type - Alert level specifying urgency.

Method Details

set

public void set(boolean active)

Sets whether the alert should currently be displayed. When activated, the alert text will also be sent to the console.

Parameters:

active - Set the alert as active and report it to the driver station.

setText

public void setText(String text)

Updates current alert text.

Parameters:

text - The text for the alert.