[wpilib] Add on/off, forward/reverse/off boolean methods to Solenoid and DoubleSolenoids

wpilibc/src/main/native/cpp/DoubleSolenoid.cpp

@@ -110,6 +110,30 @@ void DoubleSolenoid::Toggle() {
   }
 }
 
+bool DoubleSolenoid::IsForward() const {
+  return Get() == kForward;
+}
+
+bool DoubleSolenoid::IsReverse() const {
+  return Get() == kReverse;
+}
+
+bool DoubleSolenoid::IsOff() const {
+  return Get() == kOff;
+}
+
+void DoubleSolenoid::Forward() {
+  Set(kForward);
+}
+
+void DoubleSolenoid::Reverse() {
+  Set(kReverse);
+}
+
+void DoubleSolenoid::Off() {
+  Set(kOff);
+}
+
 int DoubleSolenoid::GetFwdChannel() const {
   return m_forwardChannel;
 }

wpilibc/src/main/native/cpp/Solenoid.cpp

@@ -54,6 +54,22 @@ bool Solenoid::Get() const {
   return (currentAll & m_mask) != 0;
 }
 
+bool Solenoid::IsOn() const {
+  return Get() == true;
+}
+
+bool Solenoid::IsOff() const {
+  return Get() == false;
+}
+
+void Solenoid::On() {
+  Set(true);
+}
+
+void Solenoid::Off() {
+  Set(false);
+}
+
 void Solenoid::Toggle() {
   Set(!Get());
 }

wpilibc/src/main/native/cpp/simulation/DoubleSolenoidSim.cpp

@@ -43,6 +43,30 @@ void DoubleSolenoidSim::Set(DoubleSolenoid::Value output) {
   m_module->SetSolenoidOutput(m_rev, output == DoubleSolenoid::Value::kReverse);
 }
 
+bool DoubleSolenoid::IsForward() const {
+  return Get() == kForward;
+}
+
+bool DoubleSolenoid::IsReverse() const {
+  return Get() == kReverse;
+}
+
+bool DoubleSolenoid::IsOff() const {
+  return Get() == kOff;
+}
+
+void DoubleSolenoid::Forward() {
+  Set(kForward);
+}
+
+void DoubleSolenoid::Reverse() {
+  Set(kReverse);
+}
+
+void DoubleSolenoid::Off() {
+  Set(kOff);
+}
+
 std::shared_ptr<PneumaticsBaseSim> DoubleSolenoidSim::GetModuleSim() const {
   return m_module;
 }

wpilibc/src/main/native/cpp/simulation/SolenoidSim.cpp

@@ -30,6 +30,22 @@ void SolenoidSim::SetOutput(bool output) {
   m_module->SetSolenoidOutput(m_channel, output);
 }
 
+bool SolenoidSim::IsOn() const {
+  return GetOutput() == true;
+}
+
+bool SolenoidSim::IsOff() const {
+  return GetOutput() == false;
+}
+
+void SolenoidSim::On() {
+  SetOutput(true);
+}
+
+void SolenoidSim::Off() {
+  SetOutput(false);
+}
+
 std::unique_ptr<CallbackStore> SolenoidSim::RegisterOutputCallback(
     NotifyCallback callback, bool initialNotify) {
   return m_module->RegisterSolenoidOutputCallback(m_channel, callback,

wpilibc/src/main/native/include/frc/DoubleSolenoid.h

@@ -88,6 +88,39 @@ class DoubleSolenoid : public wpi::Sendable,
    */
   void Toggle();
 
+  /**
+   * Returns true if the double solenoid is in a forward state.
+   * @return true if the double solenoid is in a forward state.
+   */
+  virtual bool IsForward() const;
+
+  /**
+   * Returns true if the double solenoid is in a reverse state.
+   * @return true if the double solenoid is in a reverse state.
+   */
+  virtual bool IsReverse() const;
+
+  /**
+   * Returns true if the double solenoid is in an off state.
+   * @return true if the double solenoid is in an off state.
+   */
+  virtual bool IsOff() const;
+
+  /**
+   * Sets the double solenoid to a forward state
+   */
+  virtual void Forward();
+
+  /**
+   * Sets the double solenoid to a reverse state
+   */
+  virtual void Reverse();
+
+  /**
+   * Sets the double solenoid to an off state
+   */
+  virtual void Off();
+
   /**
    * Get the forward channel.
    *

wpilibc/src/main/native/include/frc/Solenoid.h

@@ -61,6 +61,32 @@ class Solenoid : public wpi::Sendable, public wpi::SendableHelper<Solenoid> {
    */
   virtual bool Get() const;
 
+  /**
+   * Returns true if the solenoid is on.
+   *
+   * @return true if the solenoid is on.
+   *
+   */
+  virtual bool IsOn() const;
+
+  /**
+   * Returns true if the solenoid is off.
+   *
+   * @return true if the solenoid is off.
+   *
+   */
+  virtual bool IsOff() const;
+
+  /**
+   * Turns the solenoid on.
+   */
+  virtual void On();
+
+  /**
+   * Turns the solenoid off.
+   */
+  virtual void Off();
+
   /**
    * Toggle the value of the solenoid.
    *

wpilibc/src/main/native/include/frc/simulation/DoubleSolenoidSim.h

@@ -22,6 +22,39 @@ class DoubleSolenoidSim {
   DoubleSolenoid::Value Get() const;
   void Set(DoubleSolenoid::Value output);
 
+  /**
+   * Returns true if the double solenoid is in a forward state.
+   * @return true if the double solenoid is in a forward state.
+   */
+  virtual bool IsForward() const;
+
+  /**
+   * Returns true if the double solenoid is in a reverse state.
+   * @return true if the double solenoid is in a reverse state.
+   */
+  virtual bool IsReverse() const;
+
+  /**
+   * Returns true if the double solenoid is in an off state.
+   * @return true if the double solenoid is in an off state.
+   */
+  virtual bool IsOff() const;
+
+  /**
+   * Sets the double solenoid to a forward state
+   */
+  virtual void Forward();
+
+  /**
+   * Sets the double solenoid to a reverse state
+   */
+  virtual void Reverse();
+
+  /**
+   * Sets the double solenoid to an off state
+   */
+  virtual void Off();
+
   std::shared_ptr<PneumaticsBaseSim> GetModuleSim() const;
 
  private:

wpilibc/src/main/native/include/frc/simulation/SolenoidSim.h

@@ -21,6 +21,32 @@ class SolenoidSim {
   bool GetOutput() const;
   void SetOutput(bool output);
 
+  /**
+   * Returns true if the solenoid is on.
+   *
+   * @return true if the solenoid is on.
+   *
+   */
+  virtual bool IsOn() const;
+
+  /**
+   * Returns true if the solenoid is off.
+   *
+   * @return true if the solenoid is off.
+   *
+   */
+  virtual bool IsOff() const;
+
+  /**
+   * Turns the solenoid on.
+   */
+  virtual void On();
+
+  /**
+   * Turns the solenoid off.
+   */
+  virtual void Off();
+
   /**
    * Register a callback to be run when the output of this solenoid has changed.
    *

wpilibj/src/main/java/edu/wpi/first/wpilibj/DoubleSolenoid.java

@@ -152,6 +152,48 @@ public Value get() {
     }
   }
 
+  /**
+   * Returns true if the double solenoid is in a forward state.
+   *
+   * @return true if the double solenoid is in a forward state.
+   */
+  public boolean isForward() {
+    return get() == Value.kForward;
+  }
+
+  /**
+   * Returns true if the double solenoid is in a reverse state.
+   *
+   * @return true if the double solenoid is in a reverse state.
+   */
+  public boolean isReverse() {
+    return get() == Value.kReverse;
+  }
+
+  /**
+   * Returns true if the double solenoid is in an off state.
+   *
+   * @return true if the double solenoid in in an off state.
+   */
+  public boolean isOff() {
+    return get() == Value.kOff;
+  }
+
+  /** Sets the double solenoid to a forward state. */
+  public void forward() {
+    set(Value.kForward);
+  }
+
+  /** Sets the double solenoid to a reverse state. */
+  public void reverse() {
+    set(Value.kReverse);
+  }
+
+  /** Sets the double solenoid to a off state. */
+  public void off() {
+    set(Value.kOff);
+  }
+
   /**
    * Toggle the value of the solenoid.
    *

wpilibj/src/main/java/edu/wpi/first/wpilibj/Solenoid.java

@@ -88,6 +88,34 @@ public boolean get() {
     return (currentAll & m_mask) != 0;
   }
 
+  /**
+   * Returns true if the solenoid is on.
+   *
+   * @return true if the solenoid is on.
+   */
+  public boolean isOn() {
+    return get() == true;
+  }
+
+  /**
+   * Returns true if the solenoid is off.
+   *
+   * @return true if the solenoid off.
+   */
+  public boolean isOff() {
+    return get() == false;
+  }
+
+  /** Turns the solenoid on. */
+  public void on() {
+    set(true);
+  }
+
+  /** Turns the solenoid off */
+  public void off() {
+    set(false);
+  }
+
   /**
    * Toggle the value of the solenoid.
    *

wpilibj/src/main/java/edu/wpi/first/wpilibj/simulation/DoubleSolenoidSim.java

@@ -5,6 +5,7 @@
 package edu.wpi.first.wpilibj.simulation;
 
 import edu.wpi.first.wpilibj.DoubleSolenoid;
+import edu.wpi.first.wpilibj.DoubleSolenoid.Value;
 import edu.wpi.first.wpilibj.PneumaticsBase;
 import edu.wpi.first.wpilibj.PneumaticsModuleType;
 
@@ -67,6 +68,48 @@ public DoubleSolenoid.Value get() {
     }
   }
 
+  /**
+   * Returns true if the double solenoid is in a forward state.
+   *
+   * @return true if the double solenoid is in a forward state.
+   */
+  public boolean isForward() {
+    return get() == Value.kForward;
+  }
+
+  /**
+   * Returns true if the double solenoid is in a reverse state.
+   *
+   * @return true if the double solenoid is in a reverse state.
+   */
+  public boolean isReverse() {
+    return get() == Value.kReverse;
+  }
+
+  /**
+   * Returns true if the double solenoid is in an off state.
+   *
+   * @return true if the double solenoid in in an off state.
+   */
+  public boolean isOff() {
+    return get() == Value.kOff;
+  }
+
+  /** Sets the double solenoid to a forward state. */
+  public void forward() {
+    set(Value.kForward);
+  }
+
+  /** Sets the double solenoid to a reverse state. */
+  public void reverse() {
+    set(Value.kReverse);
+  }
+
+  /** Sets the double solenoid to a off state. */
+  public void off() {
+    set(Value.kOff);
+  }
+
   /**
    * Set the value of the double solenoid output.
    *