com.flash3388.flashlib.robot.io.devices.actuators.PositionController Maven / Gradle / Ivy

Go to download

package com.flash3388.flashlib.robot.io.devices.actuators;

import com.flash3388.flashlib.robot.motion.Stoppable;

public interface PositionController extends Stoppable {
    // TODO: COMPILE A STRONGER CONTRACT FOR THIS INTERFACE: values ranges, and meaning.

    /**
     * Sets the position of the component controlled by this object. Position is a decimal which indicates the position of the object.
     *
     * @param position the position to set the controlled object.
     */
    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();
}