org.wpilib.telemetry.TelemetryEntry Interface Reference

Public Member Functions
default boolean	isDiscard ()
void	keepDuplicates ()
void	setProperty (String key, String value)
< T > void	logStruct (T value, Struct<? super T > struct, long timestamp)
< T > void	logProtobuf (T value, Protobuf<? super T, ?> proto, long timestamp)
< T > void	logStructArray (T[] value, Struct<? super T > struct, long timestamp)
void	logBoolean (boolean value, long timestamp)
default void	logByte (byte value, long timestamp)
default void	logShort (short value, long timestamp)
default void	logInt (int value, long timestamp)
void	logLong (long value, long timestamp)
void	logFloat (float value, long timestamp)
void	logDouble (double value, long timestamp)
void	logString (String value, String typeString, long timestamp)
void	logBooleanArray (boolean[] value, long timestamp)
void	logShortArray (short[] value, long timestamp)
void	logIntArray (int[] value, long timestamp)
void	logLongArray (long[] value, long timestamp)
void	logFloatArray (float[] value, long timestamp)
void	logDoubleArray (double[] value, long timestamp)
void	logStringArray (String[] value, long timestamp)
void	logRaw (byte[] value, String typeString, long timestamp)

Detailed Description

Interface for individual telemetry entries. Intended for use by backends; most users should use the TelemetryTable class.

Implementations must not throw from logging, metadata, or discard-checking methods. Recoverable failures should be reported through TelemetryRegistry#reportWarning(String, String) and skipped.

Methods on the same entry may be called concurrently. Implementations must copy mutable input they retain after a method returns.

Definition at line 21 of file TelemetryEntry.java.

Member Function Documentation

isDiscard()

default boolean org.wpilib.telemetry.TelemetryEntry.isDiscard

(

)

Checks if this entry discards data.

Returns

true if this entry discards logged data

Definition at line 27 of file TelemetryEntry.java.

keepDuplicates()

void org.wpilib.telemetry.TelemetryEntry.keepDuplicates

(

)

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

logBoolean()

void org.wpilib.telemetry.TelemetryEntry.logBoolean	(	boolean	value,
		long	timestamp )

Logs a boolean.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logBooleanArray()

void org.wpilib.telemetry.TelemetryEntry.logBooleanArray	(	boolean[]	value,
		long	timestamp )

Logs a boolean array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logByte()

default void org.wpilib.telemetry.TelemetryEntry.logByte	(	byte	value,
		long	timestamp )

Logs a byte.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

Definition at line 92 of file TelemetryEntry.java.

logDouble()

void org.wpilib.telemetry.TelemetryEntry.logDouble	(	double	value,
		long	timestamp )

Logs a double.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logDoubleArray()

void org.wpilib.telemetry.TelemetryEntry.logDoubleArray	(	double[]	value,
		long	timestamp )

Logs a double array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logFloat()

void org.wpilib.telemetry.TelemetryEntry.logFloat	(	float	value,
		long	timestamp )

Logs a float.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logFloatArray()

void org.wpilib.telemetry.TelemetryEntry.logFloatArray	(	float[]	value,
		long	timestamp )

Logs a float array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logInt()

default void org.wpilib.telemetry.TelemetryEntry.logInt	(	int	value,
		long	timestamp )

Logs an int.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

Definition at line 114 of file TelemetryEntry.java.

logIntArray()

void org.wpilib.telemetry.TelemetryEntry.logIntArray	(	int[]	value,
		long	timestamp )

Logs an int array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logLong()

void org.wpilib.telemetry.TelemetryEntry.logLong	(	long	value,
		long	timestamp )

Logs a long.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logLongArray()

void org.wpilib.telemetry.TelemetryEntry.logLongArray	(	long[]	value,
		long	timestamp )

Logs a long array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logProtobuf()

< T > void org.wpilib.telemetry.TelemetryEntry.logProtobuf	(	T	value,
		Protobuf<? super T, ?>	proto,
		long	timestamp )

Logs an object with protobuf serialization.

Parameters

<T>	data type
value	the value
proto	protobuf serializer for the value type or one of its supertypes
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logRaw()

void org.wpilib.telemetry.TelemetryEntry.logRaw	(	byte[]	value,
		String	typeString,
		long	timestamp )

Logs a byte array (raw value).

Parameters

value	the value
typeString	the type string
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logShort()

default void org.wpilib.telemetry.TelemetryEntry.logShort	(	short	value,
		long	timestamp )

Logs a short.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

Definition at line 103 of file TelemetryEntry.java.

logShortArray()

void org.wpilib.telemetry.TelemetryEntry.logShortArray	(	short[]	value,
		long	timestamp )

Logs a short array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logString()

void org.wpilib.telemetry.TelemetryEntry.logString	(	String	value,
		String	typeString,
		long	timestamp )

Logs a String.

Parameters

value	the value
typeString	the type string
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logStringArray()

void org.wpilib.telemetry.TelemetryEntry.logStringArray	(	String[]	value,
		long	timestamp )

Logs a String array.

Parameters

value	the value
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logStruct()

< T > void org.wpilib.telemetry.TelemetryEntry.logStruct	(	T	value,
		Struct<? super T >	struct,
		long	timestamp )

Logs an object with struct serialization.

Parameters

<T>	data type
value	the value
struct	struct serializer for the value type or one of its supertypes
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

logStructArray()

< T > void org.wpilib.telemetry.TelemetryEntry.logStructArray	(	T[]	value,
		Struct<? super T >	struct,
		long	timestamp )

Logs an array of objects with struct serialization.

Parameters

<T>	data type
value	the value
struct	struct serializer for the value type or one of its supertypes
timestamp	timestamp in nanoseconds in the same time base as WPIUtilJNI.now(), or 0 to use the current time

setProperty()

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

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

Parameters

key	property key
value	property value; must be a valid JSON value string (e.g. quoted string, number, true, false, null, object, or array)

---

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

• org/wpilib/telemetry/TelemetryEntry.java