Package lib.subsystems

Class SolenoidSubsystem

java.lang.Object

edu.wpi.first.wpilibj2.command.SubsystemBase

lib.subsystems.SolenoidSubsystem

All Implemented Interfaces:

edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem

public class SolenoidSubsystem
extends edu.wpi.first.wpilibj2.command.SubsystemBase

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SolenoidSubsystem.SolenoidState	DoubleSolenoid.Value simplified to three simple states

Field Summary

Fields

Modifier and Type	Field	Description
protected SolenoidSubsystem.SolenoidState	defaultState
protected boolean	isInverted
protected edu.wpi.first.wpilibj.DoubleSolenoid[]	solenoids
protected SolenoidSubsystem.SolenoidState	state

Constructor Summary

Constructors

Constructor	Description
SolenoidSubsystem(boolean isInverted, edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)	A class that wraps multiple DoubleSolenoid objects with subsystem functionality.
SolenoidSubsystem(boolean isInverted, SolenoidSubsystem.SolenoidState defaultState, edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)	A class that wraps multiple DoubleSolenoid objects with subsystem functionality.
SolenoidSubsystem(edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)	A class that wraps multiple DoubleSolenoid objects with subsystem functionality.
SolenoidSubsystem(String name, boolean isInverted, SolenoidSubsystem.SolenoidState defaultState, edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)	A class that wraps multiple DoubleSolenoid objects with subsystem functionality.
SolenoidSubsystem(SolenoidSubsystem.SolenoidState defaultState, edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)	A class that wraps multiple DoubleSolenoid objects with subsystem functionality.

Method Summary

Modifier and Type	Method	Description
edu.wpi.first.wpilibj.DoubleSolenoid[]	getSolenoids()
SolenoidSubsystem.SolenoidState	getState()
SolenoidSubsystem.SolenoidState	invertState(SolenoidSubsystem.SolenoidState state)	Inverts the state given
boolean	isExtended()	Returns whether the solenoid is extended.
void	set(SolenoidSubsystem.SolenoidState state)	Sets the state of the system.
void	setOverride(SolenoidSubsystem.SolenoidState state)	Sets the state of the system regardless of current state

Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

addChild, getName, getSubsystem, initSendable, setName, setSubsystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

defer, getCurrentCommand, getDefaultCommand, idle, periodic, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd, startRun

Field Details

solenoids

protected edu.wpi.first.wpilibj.DoubleSolenoid[] solenoids

state

protected SolenoidSubsystem.SolenoidState state

defaultState

protected SolenoidSubsystem.SolenoidState defaultState

isInverted

protected boolean isInverted

Constructor Details

SolenoidSubsystem

public SolenoidSubsystem(String name,
 boolean isInverted,
 SolenoidSubsystem.SolenoidState defaultState,
 edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Parameters:

name - Name of the subsystem

isInverted - True if the solenoids should be inverted

defaultState - Set the default state of the SolenoidSystem

solenoids - Double solenoids of the system

SolenoidSubsystem

public SolenoidSubsystem(boolean isInverted,
 SolenoidSubsystem.SolenoidState defaultState,
 edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Parameters:

isInverted - True if the solenoids should be inverted

defaultState - Set the default state of the SolenoidSystem

solenoids - Double solenoids of the system

SolenoidSubsystem

public SolenoidSubsystem(boolean isInverted,
 edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Parameters:

isInverted - True if the solenoids should be inverted

solenoids - Double solenoids of the system

SolenoidSubsystem

public SolenoidSubsystem(SolenoidSubsystem.SolenoidState defaultState,
 edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Parameters:

defaultState - Set the default state of the SolenoidSystem

solenoids - Double solenoids of the system

SolenoidSubsystem

public SolenoidSubsystem(edu.wpi.first.wpilibj.DoubleSolenoid... solenoids)

A class that wraps multiple DoubleSolenoid objects with subsystem functionality. Allows for easy inversion and setting of default state of solenoids

Parameters:

solenoids - Double solenoids of the system

Method Details

getState

public SolenoidSubsystem.SolenoidState getState()

Returns:

Returns the current state of the system

invertState

public SolenoidSubsystem.SolenoidState invertState(SolenoidSubsystem.SolenoidState state)

Inverts the state given

Parameters:

state - SolenoidState to be inverted

Returns:

SolenoidState Inverted state

set

public void set(SolenoidSubsystem.SolenoidState state)

Sets the state of the system. Only sets if current state is not equal to state to be set

Parameters:

state - State to set system

setOverride

public void setOverride(SolenoidSubsystem.SolenoidState state)

Sets the state of the system regardless of current state

Parameters:

state - State to set

getSolenoids

public edu.wpi.first.wpilibj.DoubleSolenoid[] getSolenoids()

Returns:

solenoids DoubleSolenoid objects of the system

isExtended

public boolean isExtended()

Returns whether the solenoid is extended.

Returns:

extended