org.wpilib.tunable.TunableDouble Class Reference

Inheritance diagram for org.wpilib.tunable.TunableDouble:

Public Member Functions
abstract void	set (double value)
abstract double	get ()
double	getAsDouble ()
void	accept (double 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 TunableDouble	create ()
static TunableDouble	create (double initialValue)
static TunableDouble	create (DoubleSupplier getter, DoubleConsumer setter)
static TunableDouble	createConfig (TunableConfig config)
static TunableDouble	createConfig (double initialValue, TunableConfig config)
static TunableDouble	createConfig (DoubleSupplier getter, DoubleConsumer setter, TunableConfig config)

Protected Member Functions
	TunableDouble (TunableConfig config)
	TunableDouble (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 double.

Definition at line 11 of file TunableDouble.java.

Constructor & Destructor Documentation

TunableDouble() [1/2]

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

protected

Constructs a tunable double.

Parameters

config

tunable config

Definition at line 122 of file TunableDouble.java.

TunableDouble() [2/2]

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

protected

Constructs a tunable double.

Parameters

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

Definition at line 132 of file TunableDouble.java.

Member Function Documentation

accept()

void org.wpilib.tunable.TunableDouble.accept

(

double

value

)

Definition at line 160 of file TunableDouble.java.

create() [1/3]

TunableDouble org.wpilib.tunable.TunableDouble.create ( )

static

Creates a tunable double with the initial value of 0.0.

Returns

a tunable double

Definition at line 17 of file TunableDouble.java.

create() [2/3]

TunableDouble org.wpilib.tunable.TunableDouble.create ( double initialValue )

static

Creates a tunable double with the given initial value.

Parameters

initialValue

initial value

Returns

a tunable double

Definition at line 27 of file TunableDouble.java.

create() [3/3]

TunableDouble org.wpilib.tunable.TunableDouble.create ( DoubleSupplier getter, DoubleConsumer setter )

static

Creates a tunable double 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 double

Definition at line 40 of file TunableDouble.java.

createConfig() [1/3]

TunableDouble org.wpilib.tunable.TunableDouble.createConfig ( double initialValue, TunableConfig config )

static

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

Parameters

initialValue	initial value
config	tunable config

Returns

a tunable double

Definition at line 61 of file TunableDouble.java.

createConfig() [2/3]

TunableDouble org.wpilib.tunable.TunableDouble.createConfig ( DoubleSupplier getter, DoubleConsumer setter, TunableConfig config )

static

Creates a tunable double 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 double

Definition at line 91 of file TunableDouble.java.

createConfig() [3/3]

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

static

Creates a tunable double with the given config and an initial value of 0.0.

Parameters

config

tunable config

Returns

a tunable double

Definition at line 50 of file TunableDouble.java.

get()

abstract double org.wpilib.tunable.TunableDouble.get ( )

abstract

Gets the value.

Implementations must not throw.

Returns

value

getAsDouble()

double org.wpilib.tunable.TunableDouble.getAsDouble

(

)

Definition at line 155 of file TunableDouble.java.

set()

abstract void org.wpilib.tunable.TunableDouble.set ( double 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/TunableDouble.java