Interface PhoenixAlertable

All Known Implementing Classes:
BaseStatusSignal, CANcoder, CANdi, CANdle, CANrange, CoreCANcoder, CoreCANdi, CoreCANdle, CoreCANrange, CorePigeon2, CoreTalonFX, CoreTalonFXS, ParentDevice, Pigeon2, StatusSignal, TalonFX, TalonFXS
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface PhoenixAlertable
Interface for all types that can report a Phoenix alert.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    registerAlerts(AlertableCollection collection)
    Registers all alerts for this type to the provided collection.

  • Method Details

    • registerAlerts

      void registerAlerts(AlertableCollection collection)
      Registers all alerts for this type to the provided collection.

      When registering alerts, the provided alert IDs must be unique within the AlertableCollection. As a result, the IDs should generally contain information unique to this specific instance, such as device and signal name.

      Parameters:
      collection - Alertable collection into which the alerts are registered