org.wpilib.tunable.TunableBackend Interface Reference

Inheritance diagram for org.wpilib.tunable.TunableBackend:

Public Member Functions
record	PublishedTunable (String path, TunableBase tunable, ComplexTunable complex)
boolean	publish (String path, TunableBase tunable)
boolean	publishComplex (String path, ComplexTunable tunable)
void	remove (String path)
List< PublishedTunable >	removePrefix (String prefix)
default void	markDirty (TunableBase tunable)
void	update ()

Detailed Description

Backend interface for publishing and updating tunables.

Definition at line 10 of file TunableBackend.java.

Member Function Documentation

markDirty()

default void org.wpilib.tunable.TunableBackend.markDirty

(

TunableBase

tunable

)

Notifies the backend that a tunable has local changes.

Backend implementations must not throw from this method.

Parameters

tunable

the changed tunable

Definition at line 75 of file TunableBackend.java.

publish()

boolean org.wpilib.tunable.TunableBackend.publish	(	String	path,
		TunableBase	tunable )

Publishes a tunable.

Backend implementations must not throw from this method. Recoverable publication failures should be reported through TunableRegistry#reportWarning(String) and skipped.

Parameters

path	normalized path
tunable	the tunable

Returns

true if the tunable was published, false otherwise

Implemented in org.wpilib.backend.NetworkTablesTunableBackend.

publishComplex()

boolean org.wpilib.tunable.TunableBackend.publishComplex	(	String	path,
		ComplexTunable	tunable )

Publishes a complex tunable.

Backend implementations must not throw from this method. Recoverable publication failures should be reported through TunableRegistry#reportWarning(String) and skipped.

Parameters

path	normalized path
tunable	the tunable

Returns

true if the tunable was published, false otherwise

Implemented in org.wpilib.backend.NetworkTablesTunableBackend.

PublishedTunable()

record org.wpilib.tunable.TunableBackend.PublishedTunable	(	String	path,
		TunableBase	tunable,
		ComplexTunable	complex )

A tunable removed from a backend.

Parameters

path	normalized path
tunable	simple tunable; null for complex tunables
complex	complex tunable; null for simple tunables

Definition at line 18 of file TunableBackend.java.

remove()

void org.wpilib.tunable.TunableBackend.remove

(

String

path

)

Removes a tunable.

Backend implementations must not throw from this method.

Parameters

path	normalized path

Implemented in org.wpilib.backend.NetworkTablesTunableBackend.

removePrefix()

List< PublishedTunable > org.wpilib.tunable.TunableBackend.removePrefix

(

String

prefix

)

Removes all tunables under a prefix.

Backend implementations must not throw from this method. The returned list must describe the tunables actually removed from the backend.

Parameters

prefix

normalized path prefix

Returns

removed tunables

Implemented in org.wpilib.backend.NetworkTablesTunableBackend.

update()

void org.wpilib.tunable.TunableBackend.update

(

)

Updates all tunable values and calls callbacks where appropriate.

Backend implementations must not throw from this method. Recoverable update failures should be reported through TunableRegistry#reportWarning(String) and skipped so the robot loop and registry state can continue updating.

Implemented in org.wpilib.backend.NetworkTablesTunableBackend.

---

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

• org/wpilib/tunable/TunableBackend.java