Package yams.telemetry

Class BooleanTelemetry

java.lang.Object

yams.telemetry.BooleanTelemetry

public class BooleanTelemetry
extends Object

Boolean Telemetry for SmartMotorControllers.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enabled	Enabled?

Constructor Summary

Constructors

Constructor	Description
BooleanTelemetry(String keyString, boolean defaultVal, SmartMotorControllerTelemetry.BooleanTelemetryField field, boolean tunable)	Setup boolean telemetry for a field.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the telemetry field.
void	disable()	Disable the telemetry.
void	display(boolean state)	Display the telemetry.
void	enable()	Enable the telemetry.
boolean	get()	Get the value.
SmartMotorControllerTelemetry.BooleanTelemetryField	getField()	Get the field.
boolean	set(boolean value)	Set the value of the publisher, checking to see if the value is the same as the subscriber.
void	setDefaultValue(boolean value)	Set the default value.
void	setupNetworkTable(NetworkTable dataTable)	Setup network tables.
void	setupNetworkTables(NetworkTable dataTable, NetworkTable tuningTable)	Setup network tables.
boolean	tunable()	Check to see if the value has changed.

Methods inherited from class java.lang.Object

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

Field Details

enabled

protected boolean enabled

Enabled?

Constructor Details

BooleanTelemetry

public BooleanTelemetry(String keyString,
 boolean defaultVal,
 SmartMotorControllerTelemetry.BooleanTelemetryField field,
 boolean tunable)

Setup boolean telemetry for a field.

Parameters:

keyString - Networks table key.

defaultVal - Default value.

field - Field representing.

tunable - Tunable?

Method Details

setupNetworkTables

public void setupNetworkTables(NetworkTable dataTable,
 NetworkTable tuningTable)

Setup network tables.

Parameters:

dataTable - Data tables.

tuningTable - Tuning table.

setupNetworkTable

public void setupNetworkTable(NetworkTable dataTable)

Setup network tables.

Parameters:

dataTable - Data tables.

set

public boolean set(boolean value)

Set the value of the publisher, checking to see if the value is the same as the subscriber.

Parameters:

value - Value to set.

Returns:

True if value was able to be set.

get

public boolean get()

Get the value.

Returns:

Value.

tunable

public boolean tunable()

Check to see if the value has changed.

Returns:

True if the value has changed.

enable

public void enable()

Enable the telemetry.

disable

public void disable()

Disable the telemetry.

display

public void display(boolean state)

Display the telemetry.

Parameters:

state - Enable or disable.

getField

public SmartMotorControllerTelemetry.BooleanTelemetryField getField()

Get the field.

Returns:

field.

setDefaultValue

public void setDefaultValue(boolean value)

Set the default value.

Parameters:

value - Default value.

close

public void close()

Close the telemetry field.