Skip to content

Commit 5ccfc4a

Browse files
authored
[oldcommands] Deprecate PIDWrappers, since they use deprecated interfaces (#3868)
1 parent b6f44f9 commit 5ccfc4a

File tree

14 files changed

+90
-13
lines changed

14 files changed

+90
-13
lines changed

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogAccelerometer.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
import edu.wpi.first.wpilibj.PIDSource;
1010
import edu.wpi.first.wpilibj.PIDSourceType;
1111

12-
/** Wrapper so that PIDSource is implemented for AnalogAccelerometer for old PIDController. */
12+
/**
13+
* Wrapper so that PIDSource is implemented for AnalogAccelerometer for old PIDController.
14+
*
15+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
16+
* wrapper.
17+
*/
18+
@Deprecated(since = "2022", forRemoval = true)
1319
public class PIDAnalogAccelerometer extends AnalogAccelerometer implements PIDSource {
1420
protected PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1521

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogGyro.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
import edu.wpi.first.wpilibj.PIDSource;
1010
import edu.wpi.first.wpilibj.PIDSourceType;
1111

12-
/** Wrapper so that PIDSource is implemented for AnalogGyro for old PIDController. */
12+
/**
13+
* Wrapper so that PIDSource is implemented for AnalogGyro for old PIDController.
14+
*
15+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
16+
* wrapper.
17+
*/
18+
@Deprecated(since = "2022", forRemoval = true)
1319
public class PIDAnalogGyro extends AnalogGyro implements PIDSource {
1420
private PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1521

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogInput.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@
88
import edu.wpi.first.wpilibj.PIDSource;
99
import edu.wpi.first.wpilibj.PIDSourceType;
1010

11-
/** Wrapper so that PIDSource is implemented for AnalogInput for old PIDController. */
11+
/**
12+
* Wrapper so that PIDSource is implemented for AnalogInput for old PIDController.
13+
*
14+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
15+
* wrapper.
16+
*/
17+
@Deprecated(since = "2022", forRemoval = true)
1218
public class PIDAnalogInput extends AnalogInput implements PIDSource {
1319
protected PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1420

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogPotentiometer.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
import edu.wpi.first.wpilibj.PIDSource;
1010
import edu.wpi.first.wpilibj.PIDSourceType;
1111

12-
/** Wrapper so that PIDSource is implemented for AnalogPotentiometer for old PIDController. */
12+
/**
13+
* Wrapper so that PIDSource is implemented for AnalogPotentiometer for old PIDController.
14+
*
15+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
16+
* wrapper.
17+
*/
18+
@Deprecated(since = "2022", forRemoval = true)
1319
public class PIDAnalogPotentiometer extends AnalogPotentiometer implements PIDSource {
1420
protected PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1521

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDEncoder.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
import edu.wpi.first.wpilibj.PIDSource;
1010
import edu.wpi.first.wpilibj.PIDSourceType;
1111

12-
/** Wrapper so that PIDSource is implemented for Encoder for old PIDController. */
12+
/**
13+
* Wrapper so that PIDSource is implemented for Encoder for old PIDController.
14+
*
15+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
16+
* wrapper.
17+
*/
18+
@Deprecated(since = "2022", forRemoval = true)
1319
public class PIDEncoder extends Encoder implements PIDSource {
1420
private PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1521

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDMotorController.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
import edu.wpi.first.wpilibj.PIDOutput;
1010
import edu.wpi.first.wpilibj.motorcontrol.MotorController;
1111

12-
/** Wrapper so that PIDOutput is implemented for MotorController for old PIDController. */
12+
/**
13+
* Wrapper so that PIDOutput is implemented for MotorController for old PIDController.
14+
*
15+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
16+
* wrapper.
17+
*/
18+
@Deprecated(since = "2022", forRemoval = true)
1319
public class PIDMotorController implements PIDOutput, MotorController, Sendable {
1420
private final MotorController m_motorController;
1521

wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDUltrasonic.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010
import edu.wpi.first.wpilibj.PIDSourceType;
1111
import edu.wpi.first.wpilibj.Ultrasonic;
1212

13-
/** Wrapper so that PIDSource is implemented for Ultrasonic for old PIDController. */
13+
/**
14+
* Wrapper so that PIDSource is implemented for Ultrasonic for old PIDController.
15+
*
16+
* @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this
17+
* wrapper.
18+
*/
19+
@Deprecated(since = "2022", forRemoval = true)
1420
public class PIDUltrasonic extends Ultrasonic implements PIDSource {
1521
protected PIDSourceType m_pidSource = PIDSourceType.kDisplacement;
1622

wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogAccelerometer.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,13 @@ namespace frc {
1212
/**
1313
* Wrapper so that PIDSource is implemented for AnalogAccelerometer for old
1414
* PIDController
15+
*
16+
* @deprecated Use frc2::PIDController class instead which doesn't require this
17+
* wrapper.
1518
*/
16-
class PIDAnalogAccelerometer : public PIDSource, public AnalogAccelerometer {
19+
class WPI_DEPRECATED("Use frc2::PIDController class instead.")
20+
PIDAnalogAccelerometer : public PIDSource,
21+
public AnalogAccelerometer {
1722
using AnalogAccelerometer::AnalogAccelerometer;
1823

1924
public:

wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogGyro.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,13 @@ namespace frc {
1111

1212
/**
1313
* Wrapper so that PIDSource is implemented for AnalogGyro for old PIDController
14+
*
15+
* @deprecated Use frc2::PIDController class instead which doesn't require this
16+
* wrapper.
1417
*/
15-
class PIDAnalogGyro : public PIDSource, public AnalogGyro {
18+
class WPI_DEPRECATED("Use frc2::PIDController class instead.") PIDAnalogGyro
19+
: public PIDSource,
20+
public AnalogGyro {
1621
using AnalogGyro::AnalogGyro;
1722

1823
public:

wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogInput.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,13 @@ namespace frc {
1212
/**
1313
* Wrapper so that PIDSource is implemented for AnalogInput for old
1414
* PIDController
15+
*
16+
* @deprecated Use frc2::PIDController class instead which doesn't require this
17+
* wrapper.
1518
*/
16-
class PIDAnalogInput : public PIDSource, public AnalogInput {
19+
class WPI_DEPRECATED("Use frc2::PIDController class instead.") PIDAnalogInput
20+
: public PIDSource,
21+
public AnalogInput {
1722
using AnalogInput::AnalogInput;
1823

1924
public:

0 commit comments

Comments
 (0)