Package com.marslib.faults

Class Alert

java.lang.Object

com.marslib.faults.Alert

public class Alert
extends Object

Class for managing various alerts to be displayed on the driver station.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Alert.AlertType

Constructor Summary

Constructors

Constructor	Description
Alert(String text, Alert.AlertType type)
Alert(String group, String text, Alert.AlertType type)

Method Summary

Modifier and Type	Method	Description
boolean	get()	Returns whether this alert is currently active.
static void	resetAll()	Clears all alert groups.
void	set(boolean active)	Activates or deactivates this alert.
void	setText(String text)	Updates the displayed text of this alert.

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)

Alert

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

Method Details

resetAll

public static void resetAll()

Clears all alert groups. Required for JUnit test isolation to prevent state bleed.

set

public void set(boolean active)

Activates or deactivates this alert. When activated, the alert's timestamp is recorded and (for CRITICAL type) a critical fault is registered with MARSFaultManager.

Parameters:

active - true to activate, false to deactivate.

setText

public void setText(String text)

Updates the displayed text of this alert. If the alert is currently active, the display is refreshed immediately.

Parameters:

text - The new alert message.

get

public boolean get()

Returns whether this alert is currently active.

Returns:

true if the alert is active.