Class ParamGroup

java.lang.Object

frc.spectrumLib.params.ParamGroup

public final class ParamGroup
extends Object

Declares the params of one group. The group name is the file name: group cameras reads params/cameras.json. Get one from Params.group(String).

private static final ParamGroup CAMERAS = Params.group("cameras");
public static final DoubleParam RESEND_SECONDS =
        CAMERAS.number("settingsResendPeriodSeconds", 2.0, "s", 0.5, 30);

Method Summary

Modifier and Type	Method	Description
BooleanParam	bool(String key, boolean defaultValue)
IntParam	integer(String key, int defaultValue, String units)
IntParam	integer(String key, int defaultValue, String units, int min, int max)	A whole number within [min, max].
String	name()
DoubleParam	number(String key, double defaultValue, String units)	A number with no bounds beyond being finite.
DoubleParam	number(String key, double defaultValue, String units, double min, double max)	A number within [min, max]; a file or dashboard value outside it is refused.
StringParam	string(String key, String defaultValue)

Methods inherited from class Object

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

Method Details

name

public String name()

number

public DoubleParam number(String key,
 double defaultValue,
 String units)

A number with no bounds beyond being finite.

number

public DoubleParam number(String key,
 double defaultValue,
 String units,
 double min,
 double max)

A number within [min, max]; a file or dashboard value outside it is refused.

integer

public IntParam integer(String key,
 int defaultValue,
 String units)

integer

public IntParam integer(String key,
 int defaultValue,
 String units,
 int min,
 int max)

A whole number within [min, max].

bool

public BooleanParam bool(String key,
 boolean defaultValue)

string

public StringParam string(String key,
 String defaultValue)