com.flash3388.flashlib.io.devices.Solenoid 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 com.flash3388.flashlib.time.Time;

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

/**
 * Represents a single solenoid valve.
 * 
 *     Solenoids are electromechanically operated valves which are used
 *     to control the flow of pneumatic or hydraulic systems.
 * 
 *
 * @since FlashLib 3.0.0
 */
public interface Solenoid extends Closeable {

    /**
     * Sets whether the valve is open.
     *
     * @param open true to open, false otherwise.
     */
    void set(boolean open);

    /**
     * Gets whether the valve is open.
     *
     * @return true if open, false otherwise.
     */
    boolean get();

    void pulse(Time duration);

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