Classes
enum	EntryMetadataKind

Public Member Functions
	TelemetryTable (TelemetryBackend backend)
String	getPath ()
boolean	setType (String typeString)
String	getType ()
TelemetryTable	getTable (String name)
void	keepDuplicates (String name)
void	setProperty (String name, String key, String value)
void	log (String name, Collection<?> value) throws CollectionElementTypeRequiredException
void	log (String name, Collection<?> value, Class<?> elementType)
void	log (String name, boolean value)
void	log (String name, byte value)
void	log (String name, short value)
void	log (String name, int value)
void	log (String name, long value)
void	log (String name, float value)
void	log (String name, double value)
void	log (String name, String value)
void	log (String name, String value, String typeString)
void	log (String name, boolean[] value)
void	log (String name, short[] value)
void	log (String name, int[] value)
void	log (String name, long[] value)
void	log (String name, float[] value)
void	log (String name, double[] value)
void	log (String name, String[] value)
void	log (String name, byte[] value)
void	log (String name, byte[] value, String typeString)

Detailed Description

Telemetry sends information from the robot program to dashboards, debug tools, or log files.

For more advanced use cases, use the NetworkTables or DataLog APIs.

Definition at line 24 of file TelemetryTable.java.

Constructor & Destructor Documentation

◆ TelemetryTable()

org.wpilib.telemetry.TelemetryTable.TelemetryTable ( TelemetryBackend backend )

Constructs a root telemetry table that writes directly to a backend without using the global telemetry registry.

Parameters

backend telemetry backend

Definition at line 86 of file TelemetryTable.java.

Member Function Documentation

◆ getPath()

String org.wpilib.telemetry.TelemetryTable.getPath ( )

Gets the table path.

Returns: path with trailing "/"

Definition at line 112 of file TelemetryTable.java.

◆ getTable()

TelemetryTable org.wpilib.telemetry.TelemetryTable.getTable ( String name )

Gets a child telemetry table.

Parameters

name	table name

Returns: table

Definition at line 182 of file TelemetryTable.java.

◆ getType()

String org.wpilib.telemetry.TelemetryTable.getType ( )

Gets the table type.

Returns: Table type as set by setType(), or null if none set.

Definition at line 170 of file TelemetryTable.java.

◆ keepDuplicates()

void org.wpilib.telemetry.TelemetryTable.keepDuplicates ( String name )

Indicates duplicate values should be preserved. Normally duplicate values are ignored.

Parameters

name the name

Definition at line 334 of file TelemetryTable.java.

◆ log() [1/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		boolean	value )

Logs a boolean.

Parameters

name	the name
value	the value

Definition at line 786 of file TelemetryTable.java.

◆ log() [2/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		boolean[]	value )

Logs a boolean array.

Parameters

name	the name
value	the value

Definition at line 913 of file TelemetryTable.java.

◆ log() [3/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		byte	value )

Logs a byte.

Parameters

name	the name
value	the value

Definition at line 800 of file TelemetryTable.java.

◆ log() [4/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		byte[]	value )

Logs a raw value (byte array).

Parameters

name	the name
value	the value

Definition at line 1011 of file TelemetryTable.java.

◆ log() [5/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		byte[]	value,
		String	typeString )

Logs a raw value (byte array) with a custom type string.

Parameters

name	the name
value	the value
typeString	the type string

Definition at line 1026 of file TelemetryTable.java.

◆ log() [6/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		Collection<?>	value ) throws CollectionElementTypeRequiredException

Rejects logging a collection without an explicit element type.

Use log(String, Collection, Class) or log(String, Collection, Struct) instead.

Parameters

name	the name
value	the value

Exceptions

CollectionElementTypeRequiredException always

Definition at line 696 of file TelemetryTable.java.

◆ log() [7/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		Collection<?>	value,
		Class<?>	elementType )

Logs a collection with an explicit element type.

The element type selects the backend representation. Byte element types are logged as raw byte arrays. Boolean, Float, Double, and String element types are logged like arrays of the same element type. Number and other non-integral number element types are logged as double arrays. Short, Integer, and Long element types are logged as integer arrays. StructSerializable element types are logged with their public static struct serializer. Other element types fall back to string arrays using Object#toString().

Parameters

name	the name
value	the value
elementType	the collection element type

Definition at line 715 of file TelemetryTable.java.

◆ log() [8/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		double	value )

Logs a double.

Parameters

name	the name
value	the value

Definition at line 870 of file TelemetryTable.java.

◆ log() [9/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		double[]	value )

Logs a double array.

Parameters

name	the name
value	the value

Definition at line 983 of file TelemetryTable.java.

◆ log() [10/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		float	value )

Logs a float.

Parameters

name	the name
value	the value

Definition at line 856 of file TelemetryTable.java.

◆ log() [11/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		float[]	value )

Logs a float array.

Parameters

name	the name
value	the value

Definition at line 969 of file TelemetryTable.java.

◆ log() [12/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		int	value )

Logs an int.

Parameters

name	the name
value	the value

Definition at line 828 of file TelemetryTable.java.

◆ log() [13/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		int[]	value )

Logs an int array.

Parameters

name	the name
value	the value

Definition at line 941 of file TelemetryTable.java.

◆ log() [14/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		long	value )

Logs a long.

Parameters

name	the name
value	the value

Definition at line 842 of file TelemetryTable.java.

◆ log() [15/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		long[]	value )

Logs a long array.

Parameters

name	the name
value	the value

Definition at line 955 of file TelemetryTable.java.

◆ log() [16/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		short	value )

Logs a short.

Parameters

name	the name
value	the value

Definition at line 814 of file TelemetryTable.java.

◆ log() [17/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		short[]	value )

Logs a short array.

Parameters

name	the name
value	the value

Definition at line 927 of file TelemetryTable.java.

◆ log() [18/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		String	value )

Logs a String.

Parameters

name	the name
value	the value

Definition at line 884 of file TelemetryTable.java.

◆ log() [19/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		String	value,
		String	typeString )

Logs a String with a custom type string.

Parameters

name	the name
value	the value
typeString	the type string

Definition at line 899 of file TelemetryTable.java.

◆ log() [20/20]

void org.wpilib.telemetry.TelemetryTable.log	(	String	name,
		String[]	value )

Logs a String array.

Parameters

name	the name
value	the value

Definition at line 997 of file TelemetryTable.java.

◆ setProperty()

void org.wpilib.telemetry.TelemetryTable.setProperty	(	String	name,
		String	key,
		String	value )

Sets property for a value. Properties are stored as a key/value map.

Parameters

name	the name
key	property key
value	property value

Definition at line 360 of file TelemetryTable.java.

◆ setType()

boolean org.wpilib.telemetry.TelemetryTable.setType ( String typeString )

Sets the table type. TelemetryLoggable implementations can use this function to communicate the type of data in the table. Callers should check the return value and not log data if false is returned.

Parameters

typeString type string

Returns: False if type mismatch.

Definition at line 124 of file TelemetryTable.java.

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

org/wpilib/telemetry/TelemetryTable.java

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TelemetryTable()

Member Function Documentation

◆ getPath()

◆ getTable()

◆ getType()

◆ keepDuplicates()

◆ log() [1/20]

◆ log() [2/20]

◆ log() [3/20]

◆ log() [4/20]

◆ log() [5/20]

◆ log() [6/20]

◆ log() [7/20]

◆ log() [8/20]

◆ log() [9/20]

◆ log() [10/20]

◆ log() [11/20]

◆ log() [12/20]

◆ log() [13/20]

◆ log() [14/20]

◆ log() [15/20]

◆ log() [16/20]

◆ log() [17/20]

◆ log() [18/20]

◆ log() [19/20]

◆ log() [20/20]

◆ setProperty()

◆ setType()