org.wpilib.tunable.ComplexTunable Interface Reference

Public Member Functions
default String	getTunableType ()
void	publishTunable (TunableTable table)
default void	updateTunable ()
default void	publishChildTunable (String name, TunableBase tunable)
default void	publishChildTunable (String name, ComplexTunable tunable)
default void	removeChildTunable (String name)
default void	setChildTunableChanged (String name)

Detailed Description

The base interface for complex (internally mutable) tunable objects.

Definition at line 9 of file ComplexTunable.java.

Member Function Documentation

getTunableType()

default String org.wpilib.tunable.ComplexTunable.getTunableType

(

)

Gets the tunable table type. Default is no specified table type (null).

Returns

Table type

Definition at line 15 of file ComplexTunable.java.

publishChildTunable() [1/2]

default void org.wpilib.tunable.ComplexTunable.publishChildTunable	(	String	name,
		ComplexTunable	tunable )

Publishes a child complex tunable under all currently published paths for this complex tunable.

If this complex tunable is not currently published, this function does nothing. Complex tunables should still publish their current children from publishTunable(TunableTable) so backend migration and full republish operations can recreate the complete child set.

Parameters

name	the child name
tunable	the child complex tunable

Definition at line 62 of file ComplexTunable.java.

publishChildTunable() [2/2]

default void org.wpilib.tunable.ComplexTunable.publishChildTunable	(	String	name,
		TunableBase	tunable )

Publishes a child tunable under all currently published paths for this complex tunable.

If this complex tunable is not currently published, this function does nothing. Complex tunables should still publish their current children from publishTunable(TunableTable) so backend migration and full republish operations can recreate the complete child set.

Parameters

name	the child name
tunable	the child tunable

Definition at line 48 of file ComplexTunable.java.

publishTunable()

void org.wpilib.tunable.ComplexTunable.publishTunable

(

TunableTable

table

)

Publishes the tunable to the given table.

This function may be called when the tunable is initially published or republished during backend migration, and it must not throw. If an exception escapes, registry and backend state is not guaranteed to be restored.

Parameters

table

table

removeChildTunable()

default void org.wpilib.tunable.ComplexTunable.removeChildTunable

(

String

name

)

Removes a child tunable from all currently published paths for this complex tunable.

If this complex tunable is not currently published, this function does nothing.

Parameters

name	the child name

Definition at line 73 of file ComplexTunable.java.

setChildTunableChanged()

default void org.wpilib.tunable.ComplexTunable.setChildTunableChanged

(

String

name

)

Marks a child tunable as locally changed.

Use this for child tunables published from plain member variables when the member is mutated outside of the child tunable object.

If this complex tunable or the child tunable is not currently published, this function does nothing.

Parameters

name	the child name

Definition at line 88 of file ComplexTunable.java.

updateTunable()

default void org.wpilib.tunable.ComplexTunable.updateTunable

(

)

Updates this complex tunable.

This function must not throw. If an exception escapes, registry and backend state is not guaranteed to be restored.

Definition at line 36 of file ComplexTunable.java.

---

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

• org/wpilib/tunable/ComplexTunable.java