[wpilib] Add Toggle() function to solenoid classes (#2635)

Toggling a solenoid on a button press is a common idiom, so this
provides a more readable way of accomplishing that.
This commit is contained in:
Tyler Veness
2020-08-15 08:16:32 -07:00
committed by GitHub
parent 370e9d089f
commit c2259d42a8
6 changed files with 76 additions and 11 deletions

View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2020 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -68,6 +68,15 @@ class DoubleSolenoid : public SolenoidBase,
*/
virtual Value Get() const;
/**
* Toggle the value of the solenoid.
*
* If the solenoid is set to forward, it'll be set to reverse. If the solenoid
* is set to reverse, it'll be set to forward. If the solenoid is set to off,
* nothing happens.
*/
void Toggle();
/**
* Check if the forward solenoid is blacklisted.
*

View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2020 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -61,6 +61,14 @@ class Solenoid : public SolenoidBase,
*/
virtual bool Get() const;
/**
* Toggle the value of the solenoid.
*
* If the solenoid is set to on, it'll be turned off. If the solenoid is set
* to off, it'll be turned on.
*/
void Toggle();
/**
* Check if solenoid is blacklisted.
*