WPILibC++ 2027.0.0-alpha-4
Loading...
Searching...
No Matches
wpi::sim::AlertSim Class Referencefinal

Class to get info on simulated alerts. More...

#include <wpi/simulation/AlertSim.hpp>

Classes

struct  AlertInfo
 Information about an alert. More...

Public Member Functions

 AlertSim ()=delete

Static Public Member Functions

static int32_t GetCount ()
 Gets the number of alerts.
static std::vector< AlertInfoGetAll ()
 Gets detailed information about each alert.
static void ResetData ()
 Resets all alert simulation data.

Detailed Description

Class to get info on simulated alerts.

Constructor & Destructor Documentation

◆ AlertSim()

wpi::sim::AlertSim::AlertSim ( )
delete

Member Function Documentation

◆ GetAll()

std::vector< AlertInfo > wpi::sim::AlertSim::GetAll ( )
static

Gets detailed information about each alert.

Returns
Alerts

◆ GetCount()

int32_t wpi::sim::AlertSim::GetCount ( )
static

Gets the number of alerts.

Note: this is not guaranteed to be consistent with the number of alerts returned by GetAll.

Returns
the number of alerts

◆ ResetData()

void wpi::sim::AlertSim::ResetData ( )
static

Resets all alert simulation data.


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