Package io.github.roboblazers7617.buttonbox.controls

Class Button

java.lang.Object

io.github.roboblazers7617.buttonbox.Control

io.github.roboblazers7617.buttonbox.controls.Button

Direct Known Subclasses:

PhysicalButton

public class Button
extends Control

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Button.ButtonMode	Determines how the state of the button should be updated when the button is pressed or released.

Constructor Summary

Constructors

Constructor	Description
Button(String id)	Creates a new Button.

Method Summary

Modifier and Type	Method	Description
boolean	getState()	Gets button state
Trigger	getTrigger()	Get a trigger for the button
void	setMode(Button.ButtonMode buttonMode)	Sets the button's mode
void	setPressed(boolean pressed)	Sets whether the button is pressed or not.
void	setupNetworkTables(NetworkTable table)	Called by the Control class when the NetworkTable is set.
void	setupSimulation()	Should set up any simulation-specific things.
void	updateClient()	Updates the control's state on the client.
void	updateServer()	Updates the control's state on the server.

Methods inherited from class io.github.roboblazers7617.buttonbox.Control

getId, getTable, setTable, updateHardware, updateOnClient

Methods inherited from class java.lang.Object

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

Constructor Details

Button

public Button(String id)

Creates a new Button.

Parameters:

id - The ID string for the Button to use.

See Also:

• Control

Method Details

setupSimulation

public void setupSimulation()

Description copied from class: Control

Should set up any simulation-specific things.

Called as a part of the constructor if the library is running in simulation.

Overrides:

setupSimulation in class Control

updateServer

public void updateServer()

Description copied from class: Control

Updates the control's state on the server.

This doesn't do anything by default, and should be overridden by the class inheritting this.

Overrides:

updateServer in class Control

updateClient

public void updateClient()

Description copied from class: Control

Updates the control's state on the client. This should get any feedback from the server, but this should not interface with the buttonbox hardware.

This doesn't do anything by default, and should be overridden by the class inheritting this.

Overrides:

updateClient in class Control

setupNetworkTables

public void setupNetworkTables(NetworkTable table)

Description copied from class: Control

Called by the Control class when the NetworkTable is set. Not intended to be called outside of the class.

This should create all of the NetworkTables publishers and subscribers for the inheritting class.

Overrides:

setupNetworkTables in class Control

Parameters:

table - NetworkTable

getState

public boolean getState()

Gets button state

Returns:

button state (true = pushed, false = released)

setPressed

public void setPressed(boolean pressed)

Sets whether the button is pressed or not.

Parameters:

pressed - Is the button pressed?

getTrigger

public Trigger getTrigger()

Get a trigger for the button

Returns:

trigger

setMode

public void setMode(Button.ButtonMode buttonMode)

Sets the button's mode

Parameters:

buttonMode - mode to set the button to