WPILibC++  2020.3.2-60-g3011ebe
frc::LiveWindow Class Reference

The LiveWindow class is the public interface for putting sensors and actuators on the LiveWindow. More...

#include <LiveWindow.h>

Public Member Functions

 LiveWindow (const LiveWindow &)=delete
 
LiveWindowoperator= (const LiveWindow &)=delete
 
void EnableTelemetry (Sendable *component)
 Enable telemetry for a single component. More...
 
void DisableTelemetry (Sendable *component)
 Disable telemetry for a single component. More...
 
void DisableAllTelemetry ()
 Disable ALL telemetry.
 
bool IsEnabled () const
 
void SetEnabled (bool enabled)
 Change the enabled status of LiveWindow. More...
 
void UpdateValues ()
 Tell all the sensors to update (send) their values. More...
 

Static Public Member Functions

static LiveWindowGetInstance ()
 Get an instance of the LiveWindow main class. More...
 

Public Attributes

std::function< void()> enabled
 
std::function< void()> disabled
 

Detailed Description

The LiveWindow class is the public interface for putting sensors and actuators on the LiveWindow.

Member Function Documentation

◆ DisableTelemetry()

void frc::LiveWindow::DisableTelemetry ( Sendable component)

Disable telemetry for a single component.

Parameters
sendablecomponent

◆ EnableTelemetry()

void frc::LiveWindow::EnableTelemetry ( Sendable component)

Enable telemetry for a single component.

Parameters
sendablecomponent

◆ GetInstance()

static LiveWindow* frc::LiveWindow::GetInstance ( )
static

Get an instance of the LiveWindow main class.

This is a singleton to guarantee that there is only a single instance regardless of how many times GetInstance is called.

◆ SetEnabled()

void frc::LiveWindow::SetEnabled ( bool  enabled)

Change the enabled status of LiveWindow.

If it changes to enabled, start livewindow running otherwise stop it

◆ UpdateValues()

void frc::LiveWindow::UpdateValues ( )

Tell all the sensors to update (send) their values.

Actuators are handled through callbacks on their value changing from the SmartDashboard widgets.


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