Package com.flarerobotics.lib

Class TunableNumber

java.lang.Object

com.flarerobotics.lib.TunableNumber

public class TunableNumber
extends Object

A number which can be tuned in SmartDashboard. For any numbers that need to be tuned during runtime.

Can be used for: PID tuning, elevator height tuning, ...

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	doTuning

Constructor Summary

Constructors

Constructor	Description
TunableNumber(String key)	Constructs a new TunableNumber.

Method Summary

Modifier and Type	Method	Description
double	get()	If tuning mode is enabled, returns the tuned number.
double	getDefault()	Returns the default value.
void	setDefault(double defaultValue)	Sets the default value of the number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

doTuning

public static boolean doTuning

Constructor Details

TunableNumber

public TunableNumber(String key)

Constructs a new TunableNumber.

Parameters:

key - The key on SmartDashboard.

Method Details

get

public double get()

If tuning mode is enabled, returns the tuned number. Otherwise returns the default value.

Returns:

The current value.

getDefault

public double getDefault()

Returns the default value.

Returns:

The default value.

setDefault

public void setDefault(double defaultValue)

Sets the default value of the number.

Parameters:

defaultValue - The default value.