edu.wpi.first.wpilibj
Class DoubleSolenoid

java.lang.Object
  edu.wpi.first.wpilibj.SensorBase
      edu.wpi.first.wpilibj.SolenoidBase
          edu.wpi.first.wpilibj.DoubleSolenoid

All Implemented Interfaces:

IDevice, IDeviceController, FrcBotSimComponent

public class DoubleSolenoid
extends SolenoidBase

DoubleSolenoid class for running 2 channels of high voltage Digital Output (9472 module). The DoubleSolenoid class is typically used for pneumatics solenoids that have two positions controlled by two separate channels.

Nested Class Summary

static class

DoubleSolenoid.Value Possible values for a DoubleSolenoid

Field Summary

Fields inherited from class edu.wpi.first.wpilibj.SolenoidBase

m_allocated, m_moduleNumber

Fields inherited from class edu.wpi.first.wpilibj.SensorBase

kAnalogChannels, kAnalogModules, kDigitalChannels, kPwmChannels, kRelayChannels, kSolenoidChannels, kSolenoidModules, kSystemClockTicksPerMicrosecond, n_simProperties

Constructor Summary

DoubleSolenoid(int forwardChannel, int reverseChannel)
Constructor.

DoubleSolenoid(int moduleNumber, int forwardChannel, int reverseChannel)
Constructor.

Method Summary

void	free() Destructor.
DoubleSolenoid.Value	get() Read the current value of the solenoid.
void	set(DoubleSolenoid.Value value) Set the value of a solenoid.

Methods inherited from class edu.wpi.first.wpilibj.SolenoidBase

getAll, getAllFromDefaultModule, getAllFromModule, set

Methods inherited from class edu.wpi.first.wpilibj.SensorBase

checkAnalogChannel, checkAnalogModule, checkDigitalChannel, checkDigitalModule, checkPWMChannel, checkPWMModule, checkRelayChannel, checkRelayModule, checkSolenoidChannel, checkSolenoidModule, getDefaultAnalogModule, getDefaultDigitalModule, getDefaultSolenoidModule, getSimProperties, setDefaultAnalogModule, setDefaultDigitalModule, setDefaultSolenoidModule

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleSolenoid

public DoubleSolenoid(int forwardChannel,
                      int reverseChannel)

Constructor.

Parameters:

forwardChannel - The forward channel on the module to control.

reverseChannel - The reverse channel on the module to control.

DoubleSolenoid

public DoubleSolenoid(int moduleNumber,
                      int forwardChannel,
                      int reverseChannel)

Constructor.

Parameters:

moduleNumber - The module number of the solenoid module to use.

forwardChannel - The forward channel on the module to control.

reverseChannel - The reverse channel on the module to control.

Method Detail

free

public void free()

Destructor.

Overrides:

free in class SolenoidBase

set

public void set(DoubleSolenoid.Value value)

Set the value of a solenoid.

Parameters:

value - Move the solenoid to forward, reverse, or don't move it.

get

public DoubleSolenoid.Value get()

Read the current value of the solenoid.

Returns:

The current value of the solenoid.