Package edu.wpi.first.networktables

Interface StringSubscriber

All Superinterfaces:

AutoCloseable, PubSub, Subscriber, Supplier<String>

All Known Subinterfaces:

StringEntry

public interface StringSubscriber
extends Subscriber, Supplier<String>

NetworkTables String subscriber.

Method Summary

Modifier and Type	Method	Description
String	get()	Get the last published value.
String	get(String defaultValue)	Get the last published value.
TimestampedString	getAtomic()	Get the last published value along with its timestamp If no value has been published, returns the stored default value and a timestamp of 0.
TimestampedString	getAtomic(String defaultValue)	Get the last published value along with its timestamp If no value has been published, returns the passed defaultValue and a timestamp of 0.
StringTopic	getTopic()	Get the corresponding topic.
TimestampedString[]	readQueue()	Get an array of all value changes since the last call to readQueue.
String[]	readQueueValues()	Get an array of all value changes since the last call to readQueue.

Methods inherited from interface edu.wpi.first.networktables.PubSub

close, getHandle, isValid

Methods inherited from interface edu.wpi.first.networktables.Subscriber

exists, getLastChange

Method Details

getTopic

StringTopic getTopic()

Get the corresponding topic.

Specified by:

getTopic in interface PubSub

Returns:

Topic

get

String get()

Get the last published value. If no value has been published, returns the stored default value.

Specified by:

get in interface Supplier<String>

Returns:

value

get

String get(String defaultValue)

Get the last published value. If no value has been published, returns the passed defaultValue.

Parameters:

defaultValue - default value to return if no value has been published

Returns:

value

getAtomic

TimestampedString getAtomic()

Get the last published value along with its timestamp If no value has been published, returns the stored default value and a timestamp of 0.

Returns:

timestamped value

getAtomic

TimestampedString getAtomic(String defaultValue)

Get the last published value along with its timestamp If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters:

defaultValue - default value to return if no value has been published

Returns:

timestamped value

readQueue

TimestampedString[] readQueue()

Get an array of all value changes since the last call to readQueue. Also provides a timestamp for each value.

The "poll storage" subscribe option can be used to set the queue depth.

Returns:

Array of timestamped values; empty array if no new changes have been published since the previous call.

readQueueValues

String[] readQueueValues()

Get an array of all value changes since the last call to readQueue.

The "poll storage" subscribe option can be used to set the queue depth.

Returns:

Array of values; empty array if no new changes have been published since the previous call.