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
void	clearFlags(java.lang.String key, int flags) Clears flags on the specified key in this table.
void	clearPersistent(java.lang.String key) Stop making a key's value persistent through program restarts.
static boolean	containsKey(java.lang.String key) Checks the table and tells if it contains the specified key.
void	delete(java.lang.String key) Deletes the specified key in this table.
static boolean	getBoolean(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getBoolean(String, boolean).
static boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the boolean the key maps to.
boolean[]	getBooleanArray(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getBooleanArray(String, boolean[]).
boolean[]	getBooleanArray(java.lang.String key, boolean[] defaultValue) Returns the boolean array the key maps to.
java.lang.Boolean[]	getBooleanArray(java.lang.String key, java.lang.Boolean[] defaultValue) Returns the boolean array the key maps to.
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.
int	getFlags(java.lang.String key) Returns the flags for the specified key.
static int	getInt(java.lang.String key) Deprecated. Use getNumber instead
static int	getInt(java.lang.String key, int defaultValue) Deprecated. Use getNumber instead
java.util.Set<java.lang.String>	getKeys()
java.util.Set<java.lang.String>	getKeys(int types)
static double	getNumber(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getNumber(String, double).
static double	getNumber(java.lang.String key, double defaultValue) Returns the number the key maps to.
double[]	getNumberArray(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getNumberArray(String, double[]).
double[]	getNumberArray(java.lang.String key, double[] defaultValue) Returns the number array the key maps to.
java.lang.Double[]	getNumberArray(java.lang.String key, java.lang.Double[] defaultValue) Returns the number array the key maps to.
byte[]	getRaw(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getRaw(String, byte[]).
byte[]	getRaw(java.lang.String key, byte[] defaultValue) Returns the raw value (byte array) the key maps to.
static java.lang.String	getString(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getString(String, String).
static java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the string the key maps to.
java.lang.String[]	getStringArray(java.lang.String key) Deprecated. This exception-raising method has been replaced by the default-taking method getStringArray(String, String[]).
java.lang.String[]	getStringArray(java.lang.String key, java.lang.String[] defaultValue) Returns the string array the key maps to.
boolean	isPersistent(java.lang.String key) Returns whether the value is persistent through program restarts.
static boolean	putBoolean(java.lang.String key, boolean value) Put a boolean in the table.
boolean	putBooleanArray(java.lang.String key, boolean[] value) Put a boolean array in the table.
boolean	putBooleanArray(java.lang.String key, java.lang.Boolean[] value) Put a boolean array in the 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 boolean	putNumber(java.lang.String key, double value) Put a number in the table.
boolean	putNumberArray(java.lang.String key, double[] value) Put a number array in the table.
boolean	putNumberArray(java.lang.String key, java.lang.Double[] value) Put a number array in the table.
boolean	putRaw(java.lang.String key, byte[] value) Put a raw value (byte array) in the table.
boolean	putRaw(java.lang.String key, java.nio.ByteBuffer value, int len) Put a raw value (bytes from a byte buffer) in the table.
static boolean	putString(java.lang.String key, java.lang.String value) Put a string in the table.
boolean	putStringArray(java.lang.String key, java.lang.String[] value) Put a string array in the table.
boolean	setDefaultBoolean(java.lang.String key, boolean defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultBooleanArray(java.lang.String key, boolean[] defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultBooleanArray(java.lang.String key, java.lang.Boolean[] defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultNumber(java.lang.String key, double defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultNumberArray(java.lang.String key, double[] defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultNumberArray(java.lang.String key, java.lang.Double[] defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultRaw(java.lang.String key, byte[] defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultString(java.lang.String key, java.lang.String defaultValue) Gets the current value in the table, setting it if it does not exist.
boolean	setDefaultStringArray(java.lang.String key, java.lang.String[] defaultValue) Gets the current value in the table, setting it if it does not exist.
void	setFlags(java.lang.String key, int flags) Sets flags on the specified key in this table.
void	setPersistent(java.lang.String key) Makes a key's value persistent through program restarts.

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

containsKey

public static boolean containsKey(java.lang.String key)

Checks the table and tells if it contains the specified key.

Parameters:

key - the key to search for

Returns:

true if the table as a value assigned to the given key

getKeys

public java.util.Set<java.lang.String> getKeys(int types)

Parameters:

types - bitmask of types; 0 is treated as a "don't care".

Returns:

keys currently in the table

getKeys

public java.util.Set<java.lang.String> getKeys()

Returns:

keys currently in the table.

setPersistent

public void setPersistent(java.lang.String key)

Makes a key's value persistent through program restarts. The key cannot be null.

Parameters:

key - the key name

clearPersistent

public void clearPersistent(java.lang.String key)

Stop making a key's value persistent through program restarts. The key cannot be null.

Parameters:

key - the key name

isPersistent

public boolean isPersistent(java.lang.String key)

Returns whether the value is persistent through program restarts. The key cannot be null.

Parameters:

key - the key name

Returns:

True if the value is persistent.

setFlags

public void setFlags(java.lang.String key,
                     int flags)

Sets flags on the specified key in this table. The key can not be null.

Parameters:

key - the key name

flags - the flags to set (bitmask)

clearFlags

public void clearFlags(java.lang.String key,
                       int flags)

Clears flags on the specified key in this table. The key can not be null.

Parameters:

key - the key name

flags - the flags to clear (bitmask)

getFlags

public int getFlags(java.lang.String key)

Returns the flags for the specified key.

Parameters:

key - the key name

Returns:

the flags, or 0 if the key is not defined

delete

public void delete(java.lang.String key)

Deletes the specified key in this table. The key can not be null.

Parameters:

key - the key name

putBoolean

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

Put a boolean in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultBoolean

public boolean setDefaultBoolean(java.lang.String key,
                                 boolean defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getBoolean

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

Deprecated. This exception-raising method has been replaced by the default-taking method getBoolean(String, boolean).

Returns the boolean the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getBoolean

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

Returns the boolean the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putNumber

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

Put a number in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultNumber

public boolean setDefaultNumber(java.lang.String key,
                                double defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getNumber

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

Deprecated. This exception-raising method has been replaced by the default-taking method getNumber(String, double).

Returns the number the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getNumber

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

Returns the number the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putString

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

Put a string in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultString

public boolean setDefaultString(java.lang.String key,
                                java.lang.String defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getString

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

Deprecated. This exception-raising method has been replaced by the default-taking method getString(String, String).

Returns the string the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getString

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

Returns the string the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putBooleanArray

public boolean putBooleanArray(java.lang.String key,
                               boolean[] value)

Put a boolean array in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

putBooleanArray

public boolean putBooleanArray(java.lang.String key,
                               java.lang.Boolean[] value)

Put a boolean array in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultBooleanArray

public boolean setDefaultBooleanArray(java.lang.String key,
                                      boolean[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

setDefaultBooleanArray

public boolean setDefaultBooleanArray(java.lang.String key,
                                      java.lang.Boolean[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getBooleanArray

@Deprecated
public boolean[] getBooleanArray(java.lang.String key)
                                       throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getBooleanArray(String, boolean[]).

Returns the boolean array the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getBooleanArray

public boolean[] getBooleanArray(java.lang.String key,
                                 boolean[] defaultValue)

Returns the boolean array the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

getBooleanArray

public java.lang.Boolean[] getBooleanArray(java.lang.String key,
                                           java.lang.Boolean[] defaultValue)

Returns the boolean array the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putNumberArray

public boolean putNumberArray(java.lang.String key,
                              double[] value)

Put a number array in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

putNumberArray

public boolean putNumberArray(java.lang.String key,
                              java.lang.Double[] value)

Put a number array in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultNumberArray

public boolean setDefaultNumberArray(java.lang.String key,
                                     double[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

setDefaultNumberArray

public boolean setDefaultNumberArray(java.lang.String key,
                                     java.lang.Double[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getNumberArray

@Deprecated
public double[] getNumberArray(java.lang.String key)
                                     throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getNumberArray(String, double[]).

Returns the number array the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getNumberArray

public double[] getNumberArray(java.lang.String key,
                               double[] defaultValue)

Returns the number array the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

getNumberArray

public java.lang.Double[] getNumberArray(java.lang.String key,
                                         java.lang.Double[] defaultValue)

Returns the number array the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putStringArray

public boolean putStringArray(java.lang.String key,
                              java.lang.String[] value)

Put a string array in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultStringArray

public boolean setDefaultStringArray(java.lang.String key,
                                     java.lang.String[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getStringArray

@Deprecated
public java.lang.String[] getStringArray(java.lang.String key)
                                               throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getStringArray(String, String[]).

Returns the string array the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getStringArray

public java.lang.String[] getStringArray(java.lang.String key,
                                         java.lang.String[] defaultValue)

Returns the string array the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putRaw

public boolean putRaw(java.lang.String key,
                      byte[] value)

Put a raw value (byte array) in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

putRaw

public boolean putRaw(java.lang.String key,
                      java.nio.ByteBuffer value,
                      int len)

Put a raw value (bytes from a byte buffer) in the table.

Parameters:

key - the key to be assigned to

value - the value that will be assigned

len - the length of the value

Returns:

False if the table key already exists with a different type

setDefaultRaw

public boolean setDefaultRaw(java.lang.String key,
                             byte[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getRaw

@Deprecated
public byte[] getRaw(java.lang.String key)
                           throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getRaw(String, byte[]).

Returns the raw value (byte array) the key maps to.

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getRaw

public byte[] getRaw(java.lang.String key,
                     byte[] defaultValue)

Returns the raw value (byte array) the key maps to. If the key does not exist or is of different type, it will return the default value.

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putInt

@Deprecated
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

@Deprecated
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

@Deprecated
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

@Deprecated
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

@Deprecated
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

@Deprecated
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:

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

java.lang.IllegalArgumentException - if the key is null