ctre::phoenix6::PhoenixAlertable Class Reference

Interface for all types that can report a Phoenix alert. More...

#include <ctre/phoenix6/Alertable.hpp>

Inheritance diagram for ctre::phoenix6::PhoenixAlertable:

Public Types
using	AlertLevel = PhoenixAlert::Level
	Levels of urgency of a registered alert.

Public Member Functions
virtual void	RegisterAlerts (AlertableCollection &collection)=0
	Registers all alerts for this type to the provided collection.

Detailed Description

Interface for all types that can report a Phoenix alert.

Member Typedef Documentation

AlertLevel

using ctre::phoenix6::PhoenixAlertable::AlertLevel = PhoenixAlert::Level

Levels of urgency of a registered alert.

Member Function Documentation

RegisterAlerts()

virtual void ctre::phoenix6::PhoenixAlertable::RegisterAlerts ( AlertableCollection & collection )

pure virtual

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

Implemented in ctre::phoenix6::BaseStatusSignal, ctre::phoenix6::hardware::core::CoreCANcoder, ctre::phoenix6::hardware::core::CoreCANdi, ctre::phoenix6::hardware::core::CoreCANdle, ctre::phoenix6::hardware::core::CoreCANrange, ctre::phoenix6::hardware::core::CorePigeon2, ctre::phoenix6::hardware::core::CoreTalonFX, ctre::phoenix6::hardware::core::CoreTalonFXS, and ctre::phoenix6::hardware::ParentDevice.

---

The documentation for this class was generated from the following file:

• ctre/phoenix6/Alertable.hpp