org.wpilib.tunable.TunableTable Class Reference

Public Member Functions
String	getPath ()
TunableTable	getTable (String name)
boolean	publish (String name, TunableBase tunable)
boolean	publish (String name, ComplexTunable tunable)
TunableBoolean	publishBoolean (String name, BooleanSupplier getter, BooleanConsumer setter)
TunableBoolean	publishBoolean (String name, BooleanSupplier getter, BooleanConsumer setter, TunableConfig config)
TunableInt	publishInt (String name, IntSupplier getter, IntConsumer setter)
TunableInt	publishInt (String name, IntSupplier getter, IntConsumer setter, TunableConfig config)
TunableLong	publishLong (String name, LongSupplier getter, LongConsumer setter)
TunableLong	publishLong (String name, LongSupplier getter, LongConsumer setter, TunableConfig config)
TunableFloat	publishFloat (String name, FloatSupplier getter, FloatConsumer setter)
TunableFloat	publishFloat (String name, FloatSupplier getter, FloatConsumer setter, TunableConfig config)
TunableDouble	publishDouble (String name, DoubleSupplier getter, DoubleConsumer setter)
TunableDouble	publishDouble (String name, DoubleSupplier getter, DoubleConsumer setter, TunableConfig config)
void	remove (String name)

Detailed Description

Tunables are used to allow values in the robot program to be changed from dashboards or debug tools.

Getter/setter-backed publish methods take getters and setters that must not throw.

For more advanced use cases, use NetworkTables directly.

Definition at line 29 of file TunableTable.java.

Member Function Documentation

getPath()

String org.wpilib.tunable.TunableTable.getPath

(

)

Gets the table path.

Returns

path with trailing "/"

Definition at line 46 of file TunableTable.java.

getTable()

TunableTable org.wpilib.tunable.TunableTable.getTable

(

String

name

)

Gets a child tunable table.

Parameters

name	table name

Returns

table

Definition at line 56 of file TunableTable.java.

publish() [1/2]

boolean org.wpilib.tunable.TunableTable.publish	(	String	name,
		ComplexTunable	tunable )

Publishes a complex tunable.

Parameters

name	the name
tunable	the tunable

Returns

true if the backend accepted the tunable

Definition at line 78 of file TunableTable.java.

publish() [2/2]

boolean org.wpilib.tunable.TunableTable.publish	(	String	name,
		TunableBase	tunable )

Publishes a tunable.

Parameters

name	the name
tunable	the tunable

Returns

true if the backend accepted the tunable

Definition at line 67 of file TunableTable.java.

publishBoolean() [1/2]

TunableBoolean org.wpilib.tunable.TunableTable.publishBoolean	(	String	name,
		BooleanSupplier	getter,
		BooleanConsumer	setter )

Publishes a tunable boolean value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter

Returns

the tunable

Definition at line 123 of file TunableTable.java.

publishBoolean() [2/2]

TunableBoolean org.wpilib.tunable.TunableTable.publishBoolean	(	String	name,
		BooleanSupplier	getter,
		BooleanConsumer	setter,
		TunableConfig	config )

Publishes a tunable boolean value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter
config	tunable config

Returns

the tunable

Definition at line 137 of file TunableTable.java.

publishDouble() [1/2]

TunableDouble org.wpilib.tunable.TunableTable.publishDouble	(	String	name,
		DoubleSupplier	getter,
		DoubleConsumer	setter )

Publishes a tunable double value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter

Returns

the tunable

Definition at line 236 of file TunableTable.java.

publishDouble() [2/2]

TunableDouble org.wpilib.tunable.TunableTable.publishDouble	(	String	name,
		DoubleSupplier	getter,
		DoubleConsumer	setter,
		TunableConfig	config )

Publishes a tunable double value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter
config	tunable config

Returns

the tunable

Definition at line 249 of file TunableTable.java.

publishFloat() [1/2]

TunableFloat org.wpilib.tunable.TunableTable.publishFloat	(	String	name,
		FloatSupplier	getter,
		FloatConsumer	setter )

Publishes a tunable float value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter

Returns

the tunable

Definition at line 208 of file TunableTable.java.

publishFloat() [2/2]

TunableFloat org.wpilib.tunable.TunableTable.publishFloat	(	String	name,
		FloatSupplier	getter,
		FloatConsumer	setter,
		TunableConfig	config )

Publishes a tunable float value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter
config	tunable config

Returns

the tunable

Definition at line 221 of file TunableTable.java.

publishInt() [1/2]

TunableInt org.wpilib.tunable.TunableTable.publishInt	(	String	name,
		IntSupplier	getter,
		IntConsumer	setter )

Publishes a tunable integer value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter

Returns

the tunable

Definition at line 152 of file TunableTable.java.

publishInt() [2/2]

TunableInt org.wpilib.tunable.TunableTable.publishInt	(	String	name,
		IntSupplier	getter,
		IntConsumer	setter,
		TunableConfig	config )

Publishes a tunable integer value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter
config	tunable config

Returns

the tunable

Definition at line 165 of file TunableTable.java.

publishLong() [1/2]

TunableLong org.wpilib.tunable.TunableTable.publishLong	(	String	name,
		LongSupplier	getter,
		LongConsumer	setter )

Publishes a tunable long value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter

Returns

the tunable

Definition at line 180 of file TunableTable.java.

publishLong() [2/2]

TunableLong org.wpilib.tunable.TunableTable.publishLong	(	String	name,
		LongSupplier	getter,
		LongConsumer	setter,
		TunableConfig	config )

Publishes a tunable long value using a getter and setter.

Parameters

name	the name
getter	the getter
setter	the setter
config	tunable config

Returns

the tunable

Definition at line 193 of file TunableTable.java.

remove()

void org.wpilib.tunable.TunableTable.remove

(

String

name

)

Removes a tunable.

Parameters

name

name

Definition at line 261 of file TunableTable.java.

---

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

• org/wpilib/tunable/TunableTable.java