edu.wpi.first.wpilibj.smartdashboard

Class SmartDashboard

java.lang.Object

edu.wpi.first.wpilibj.smartdashboard.SmartDashboard

public class SmartDashboard
extends java.lang.Object

The SmartDashboard class is the bridge between robot programs and the SmartDashboard on the laptop.

When a value is put into the SmartDashboard here, it pops up on the SmartDashboard on the laptop. Users can put values into and get values from the SmartDashboard

Constructor Summary

Constructors

Constructor and Description
SmartDashboard()

Method Summary

Modifier and Type	Method and Description
static boolean	getBoolean(java.lang.String key) Returns the value at the specified key.
static boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the value at the specified key.
static Sendable	getData(java.lang.String key) Returns the value at the specified key.
static double	getDouble(java.lang.String key) Deprecated. Use getNumber instead
static double	getDouble(java.lang.String key, double defaultValue) Deprecated. Use getNumber instead.
static int	getInt(java.lang.String key) Deprecated. Use getNumber instead
static int	getInt(java.lang.String key, int defaultValue) Deprecated. Use getNumber instead
static double	getNumber(java.lang.String key) Returns the value at the specified key.
static double	getNumber(java.lang.String key, double defaultValue) Returns the value at the specified key.
static java.lang.String	getString(java.lang.String key) Returns the value at the specified key.
static java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the value at the specified key.
static void	putBoolean(java.lang.String key, boolean value) Maps the specified key to the specified value in this table.
static void	putData(NamedSendable value) Maps the specified key (where the key is the name of the NamedSendable SmartDashboardNamedData to the specified value in this table.
static void	putData(java.lang.String key, Sendable data) Maps the specified key to the specified value in this table.
static void	putDouble(java.lang.String key, double value) Deprecated. UseputNumber instead
static void	putInt(java.lang.String key, int value) Deprecated. Use putNumber method instead
static void	putNumber(java.lang.String key, double value) Maps the specified key to the specified value in this table.
static void	putString(java.lang.String key, java.lang.String value) Maps the specified key to the specified value in this table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartDashboard

public SmartDashboard()

Method Detail

putData

public static void putData(java.lang.String key,
                           Sendable data)

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

data - the value

Throws:

java.lang.IllegalArgumentException - if key is null

putData

public static void putData(NamedSendable value)

Maps the specified key (where the key is the name of the NamedSendable SmartDashboardNamedData to the specified value in this table. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

value - the value

Throws:

java.lang.IllegalArgumentException - if key is null

getData

public static Sendable getData(java.lang.String key)

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

NetworkTableKeyNotDefined - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the key is null

putBoolean

public static void putBoolean(java.lang.String key,
                              boolean value)

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - if key is null

getBoolean

public static boolean getBoolean(java.lang.String key)
                          throws TableKeyNotDefinedException

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

NetworkTableKeyNotDefined - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a boolean

java.lang.IllegalArgumentException - if the key is null

TableKeyNotDefinedException

getBoolean

public static boolean getBoolean(java.lang.String key,
                                 boolean defaultValue)

Returns the value at the specified key.

Parameters:

key - the key

defaultValue - returned if the key doesn't exist

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the value mapped to by the key is not a boolean

java.lang.IllegalArgumentException - if the key is null

putNumber

public static void putNumber(java.lang.String key,
                             double value)

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - if key is null

getNumber

public static double getNumber(java.lang.String key)
                        throws TableKeyNotDefinedException

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null

getNumber

public static double getNumber(java.lang.String key,
                               double defaultValue)

Returns the value at the specified key.

Parameters:

key - the key

defaultValue - the value returned if the key is undefined

Returns:

the value

Throws:

NetworkTableKeyNotDefined - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null

putString

public static void putString(java.lang.String key,
                             java.lang.String value)

Maps the specified key to the specified value in this table. Neither the key nor the value can be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - if key or value is null

getString

public static java.lang.String getString(java.lang.String key)
                                  throws TableKeyNotDefinedException

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

NetworkTableKeyNotDefined - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a string

java.lang.IllegalArgumentException - if the key is null

TableKeyNotDefinedException

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.String defaultValue)

Returns the value at the specified key.

Parameters:

key - the key

defaultValue - The value returned if the key is undefined

Returns:

the value

Throws:

NetworkTableKeyNotDefined - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a string

java.lang.IllegalArgumentException - if the key is null

putInt

public static void putInt(java.lang.String key,
                          int value)

Deprecated. Use putNumber method instead

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - if key is null

getInt

public static int getInt(java.lang.String key)
                  throws TableKeyNotDefinedException

Deprecated. Use getNumber instead

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not an int

java.lang.IllegalArgumentException - if the key is null

getInt

public static int getInt(java.lang.String key,
                         int defaultValue)
                  throws TableKeyNotDefinedException

Deprecated. Use getNumber instead

Returns the value at the specified key.

Parameters:

key - the key

defaultValue - the value returned if the key is undefined

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not an int

java.lang.IllegalArgumentException - if the key is null

putDouble

public static void putDouble(java.lang.String key,
                             double value)

Deprecated. UseputNumber instead

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - if key is null

getDouble

public static double getDouble(java.lang.String key)
                        throws TableKeyNotDefinedException

Deprecated. Use getNumber instead

Returns the value at the specified key.

Parameters:

key - the key

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null

getDouble

public static double getDouble(java.lang.String key,
                               double defaultValue)

Deprecated. Use getNumber instead.

Returns the value at the specified key.

Parameters:

key - the key

defaultValue - the value returned if the key is undefined

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null