com.pi4j.io.gpio.analog.AnalogOutputConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.io.gpio.analog;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  AnalogOutputConfig.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.pi4j.context.Context;

/**
 * AnalogOutputConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface AnalogOutputConfig
        extends AnalogConfig {

    /** Constant SHUTDOWN_VALUE_KEY="shutdown" */
    String SHUTDOWN_VALUE_KEY = "shutdown";
    /** Constant INITIAL_VALUE_KEY="initial" */
    String INITIAL_VALUE_KEY = "initial";
    /** Constant STEP_VALUE_KEY="step" */
    String STEP_VALUE_KEY = "step";

    /**
     * shutdownValue.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer shutdownValue();
    /**
     * shutdownValue.
     *
     * @param value a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutputConfig} object.
     */
    AnalogOutputConfig shutdownValue(Integer value);
    /**
     * getShutdownValue.
     *
     * @return a {@link java.lang.Number} object.
     */
    default Number getShutdownValue() {
        return this.shutdownValue();
    }
    /**
     * setShutdownValue.
     *
     * @param value a {@link java.lang.Integer} object.
     */
    default void setShutdownValue(Integer value) {
        this.shutdownValue(value);
    }

    /**
     * stepValue.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer stepValue();
    /**
     * stepValue.
     *
     * @param value a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutputConfig} object.
     */
    AnalogOutputConfig stepValue(Integer value);
    /**
     * getStepValue.
     *
     * @return a {@link java.lang.Number} object.
     */
    default Number getStepValue() {
        return this.stepValue();
    }
    /**
     * setStepValue.
     *
     * @param value a {@link java.lang.Integer} object.
     */
    default void setStepValue(Integer value) {
        this.setStepValue(value);
    }

    /**
     * initialValue.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer initialValue();
    /**
     * getInitialValue.
     *
     * @return a {@link java.lang.Number} object.
     */
    default Number getInitialValue() {
        return this.initialValue();
    }


    /**
     * newBuilder.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutputConfigBuilder} object.
     */
    static AnalogOutputConfigBuilder newBuilder(Context context)  {
        return AnalogOutputConfigBuilder.newInstance(context);
    }
}