org.wpilib.tunable.TunableBoolean Class Reference

Inheritance diagram for org.wpilib.tunable.TunableBoolean:

Public Member Functions
abstract void	set (boolean value)
abstract boolean	get ()
boolean	getAsBoolean ()
void	accept (boolean value)
Public Member Functions inherited from org.wpilib.tunable.TunableBase
boolean	isRobust ()
String	getProperties ()
TunableConfig	getConfig ()
boolean	hasChanged ()
boolean	supportsChangeNotification ()
void	resetChanged ()

Static Public Member Functions
static TunableBoolean	create ()
static TunableBoolean	create (boolean initialValue)
static TunableBoolean	create (BooleanSupplier getter, BooleanConsumer setter)
static TunableBoolean	createConfig (TunableConfig config)
static TunableBoolean	createConfig (boolean initialValue, TunableConfig config)
static TunableBoolean	createConfig (BooleanSupplier getter, BooleanConsumer setter, TunableConfig config)

Protected Member Functions
	TunableBoolean (TunableConfig config)
	TunableBoolean (TunableConfig config, boolean supportsChangeNotification)
Protected Member Functions inherited from org.wpilib.tunable.TunableBase
	TunableBase (TunableConfig config)
	TunableBase (TunableConfig config, boolean supportsChangeNotification)
void	markChanged ()

Additional Inherited Members
Protected Attributes inherited from org.wpilib.tunable.TunableBase
boolean	m_changed

Detailed Description

A tunable boolean.

Definition at line 11 of file TunableBoolean.java.

Constructor & Destructor Documentation

TunableBoolean() [1/2]

org.wpilib.tunable.TunableBoolean.TunableBoolean ( TunableConfig config )

protected

Constructs a tunable boolean.

Parameters

config

tunable config

Definition at line 123 of file TunableBoolean.java.

TunableBoolean() [2/2]

org.wpilib.tunable.TunableBoolean.TunableBoolean ( TunableConfig config, boolean supportsChangeNotification )

protected

Constructs a tunable boolean.

Parameters

config	tunable config
supportsChangeNotification	whether the tunable notifies backends when it changes

Definition at line 133 of file TunableBoolean.java.

Member Function Documentation

accept()

void org.wpilib.tunable.TunableBoolean.accept

(

boolean

value

)

Performs this operation on the given argument.

Parameters

value

the input argument

Implements org.wpilib.util.function.BooleanConsumer.

Definition at line 161 of file TunableBoolean.java.

create() [1/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.create ( )

static

Creates a tunable boolean with the initial value of false.

Returns

a tunable boolean

Definition at line 18 of file TunableBoolean.java.

create() [2/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.create ( boolean initialValue )

static

Creates a tunable boolean with the given initial value.

Parameters

initialValue

initial value

Returns

a tunable boolean

Definition at line 28 of file TunableBoolean.java.

create() [3/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.create ( BooleanSupplier getter, BooleanConsumer setter )

static

Creates a tunable boolean with the given getter and setter.

The getter and setter must not throw.

Parameters

getter	getter for the tunable value
setter	setter for the tunable value

Returns

a tunable boolean

Definition at line 41 of file TunableBoolean.java.

createConfig() [1/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.createConfig ( boolean initialValue, TunableConfig config )

static

Creates a tunable boolean with the given initial value and config.

Parameters

initialValue	initial value
config	tunable config

Returns

a tunable boolean

Definition at line 62 of file TunableBoolean.java.

createConfig() [2/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.createConfig ( BooleanSupplier getter, BooleanConsumer setter, TunableConfig config )

static

Creates a tunable boolean with the given getter, setter, and config.

The getter and setter must not throw.

Parameters

getter	getter for the tunable value
setter	setter for the tunable value
config	tunable config

Returns

a tunable boolean

Definition at line 92 of file TunableBoolean.java.

createConfig() [3/3]

TunableBoolean org.wpilib.tunable.TunableBoolean.createConfig ( TunableConfig config )

static

Creates a tunable boolean with the given config and an initial value of false.

Parameters

config

tunable config

Returns

a tunable boolean

Definition at line 51 of file TunableBoolean.java.

get()

abstract boolean org.wpilib.tunable.TunableBoolean.get ( )

abstract

Gets the value.

Implementations must not throw.

Returns

value

getAsBoolean()

boolean org.wpilib.tunable.TunableBoolean.getAsBoolean

(

)

Definition at line 156 of file TunableBoolean.java.

set()

abstract void org.wpilib.tunable.TunableBoolean.set ( boolean value )

abstract

Sets the value.

Implementations must not throw.

Parameters

value

value

---

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

• org/wpilib/tunable/TunableBoolean.java