com.flash3388.flashlib.io.devices.DoubleSolenoid Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flashlib.core.io Show documentation

Robotics development framework (flashlib.core.io)

The newest version!

package com.flash3388.flashlib.io.devices;

import java.io.Closeable;
import java.io.IOException;

/**
 * Represents a double solenoid valve.
 * 
 *     Solenoids are electromechanically operated valves which are used
 *     to control the flow of pneumatic or hydraulic systems.
 * 
 * 
 *     Double solenoids use two solenoids to operate the valve,
 *     with voltage being applied to one of the to either close
 *     or open the value. When voltage is applied to both, or neither,
 *     the solenoid does not change position.
 * 
 *
 * @since FlashLib 3.0.0
 */
public interface DoubleSolenoid extends Closeable {

    /**
     * Operation values for {@link DoubleSolenoid}.
     *
     * @since FlashLib 3.0.0
     */
    enum Value {
        /**
         * Valve open.
         */
        FORWARD,
        /**
         * Valve close.
         */
        REVERSE,
        /**
         * No power to either solenoids.
         */
        OFF
    }

    /**
     * Sets the value to the solenoid.
     *
     * @param value {@link Value} indicating which solenoid to apply current to.
     */
    void set(Value value);

    /**
     * Gets the current value of the solenoid.
     *
     * @return {@link Value} indicating which solenoid has currently applied to it.
     */
    Value get();

    @Override
    default void close() throws IOException {
    }
}