WPILibC++  2018.4.1-1228-gb9fa3a4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Shuffleboard.h
1 /*----------------------------------------------------------------------------*/
2 /* Copyright (c) 2018 FIRST. All Rights Reserved. */
3 /* Open Source Software - may be modified and shared by FRC teams. The code */
4 /* must be accompanied by the FIRST BSD license file in the root directory of */
5 /* the project. */
6 /*----------------------------------------------------------------------------*/
7 
8 #pragma once
9 
10 #include <wpi/StringRef.h>
11 
12 #include "frc/shuffleboard/ShuffleboardInstance.h"
13 
14 namespace frc {
15 
16 class ShuffleboardTab;
17 
58 class Shuffleboard final {
59  public:
64  static constexpr const char* kBaseTableName = "/Shuffleboard";
65 
72  static void Update();
73 
81  static ShuffleboardTab& GetTab(wpi::StringRef title);
82 
90  static void EnableActuatorWidgets();
91 
98  static void DisableActuatorWidgets();
99 
100  private:
101  static detail::ShuffleboardInstance& GetInstance();
102 
103  // TODO usage reporting
104 
105  Shuffleboard() = default;
106 };
107 
108 } // namespace frc
109 
110 // Make use of references returned by member functions usable
111 #include "frc/shuffleboard/ShuffleboardTab.h"
WPILib FRC namespace.
Definition: SPIAccelerometerSim.h:18
Definition: ShuffleboardInstance.h:18
The Shuffleboard class provides a mechanism with which data can be added and laid out in the Shuffleb...
Definition: Shuffleboard.h:58
static void Update()
Updates all the values in Shuffleboard.
static void DisableActuatorWidgets()
Disables user control of widgets containing actuators.
static ShuffleboardTab & GetTab(wpi::StringRef title)
Gets the Shuffleboard tab with the given title, creating it if it does not already exist...
Represents a tab in the Shuffleboard dashboard.
Definition: ShuffleboardTab.h:29
static void EnableActuatorWidgets()
Enables user control of widgets containing actuators: speed controllers, relays, etc.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
static constexpr const char * kBaseTableName
The name of the base NetworkTable into which all Shuffleboard data will be added. ...
Definition: Shuffleboard.h:64