com.flash3388.flashlib.io.devices.PositionController 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.control.Stoppable;

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

/**
 * Represents controller component for position-based actuator,
 * such as a Servo, Stepper and such.
 *
 * @since FlashLib 2.0.0
 */
public interface PositionController extends Closeable, Stoppable {

    /**
     * Sets the position of the component controlled by this object.
     *
     * @param position the position to set the controlled object between 0 and 1,
     *                 representing percentages from initial position to max position.
     */
    void set(double position);

    /**
     * Gets the current position of the component controlled by this object.
     *
     * @return the position of the controlled object.
     */
    double get();

    /**
     * Stops the motion of the controlled component.
     */
    @Override
    void stop();

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