TunableFloat.java

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
package org.wpilib.tunable;
 
import org.wpilib.util.function.FloatConsumer;
import org.wpilib.util.function.FloatSupplier;

public abstract class TunableFloat extends TunableBase implements FloatSupplier, FloatConsumer {
  public static TunableFloat create() {
    return create(0.0f);
  }

  public static TunableFloat create(float initialValue) {
    return createConfig(initialValue, null);
  }

  public static TunableFloat create(FloatSupplier getter, FloatConsumer setter) {
    return createConfig(getter, setter, null);
  }

  public static TunableFloat createConfig(TunableConfig config) {
    return createConfig(0.0f, config);
  }

  public static TunableFloat createConfig(float initialValue, TunableConfig config) {
    return new TunableFloat(config, true) {
      @Override
      public void set(float value) {
        if (Float.compare(m_value, value) == 0) {
          return;
        }
        m_value = value;
        markChanged();
      }
 
      @Override
      public float get() {
        return m_value;
      }
 
      private float m_value = initialValue;
    };
  }

  public static TunableFloat createConfig(
      FloatSupplier getter, FloatConsumer setter, TunableConfig config) {
    if (config == null) {
      config = TunableConfig.of(TunableOption.ALWAYS_GET);
    } else if (config.getPolling() == TunableConfig.Polling.DEFAULT) {
      config = config.withPolling(TunableConfig.Polling.ALWAYS_GET);
    }
    return new TunableFloat(config, true) {
      @Override
      public void set(float value) {
        boolean changed = Float.compare(getter.getAsFloat(), value) != 0;
        if (setter != null) {
          setter.accept(value);
        }
        if (changed) {
          markChanged();
        }
      }
 
      @Override
      public float get() {
        return getter.getAsFloat();
      }
    };
  }

  protected TunableFloat(TunableConfig config) {
    super(config);
  }

  protected TunableFloat(TunableConfig config, boolean supportsChangeNotification) {
    super(config, supportsChangeNotification);
  }

  public abstract void set(float value);

  public abstract float get();
 
  @Override
  public float getAsFloat() {
    return get();
  }
 
  @Override
  public void accept(float value) {
    set(value);
  }
}