[commands, documentation] Remove controller replaceme commands

Also add a note about using command factories
wpilibsuite · Oct 8, 2024 · 09cc499 · 09cc499
1 parent f856c05
commit 09cc499
Show file tree

Hide file tree

Showing 24 changed files with 17 additions and 511 deletions.
diff --git a/wpilibcExamples/src/main/cpp/commands/command2/ReplaceMeCommand2.h b/wpilibcExamples/src/main/cpp/commands/command2/ReplaceMeCommand2.h
@@ -17,6 +17,7 @@
 class ReplaceMeCommand2
     : public frc2::CommandHelper<frc2::Command, ReplaceMeCommand2> {
  public:
+  /* You should consider using the more terse Command factories API instead https://docs.wpilib.org/en/stable/docs/software/commandbased/organizing-command-based.html#defining-commands */
   ReplaceMeCommand2();
 
   void Initialize() override;

diff --git a/wpilibcExamples/src/main/cpp/commands/commands.json b/wpilibcExamples/src/main/cpp/commands/commands.json
@@ -95,70 +95,6 @@
     "replacename": "ReplaceMeParallelRaceGroup",
     "commandversion": 2
   },
-  {
-    "name": "PIDCommand",
-    "description": "A command that runs a PIDController.",
-    "tags": [
-      "pidcommand"
-    ],
-    "foldername": "pidcommand",
-    "headers": [
-      "ReplaceMePIDCommand.h"
-    ],
-    "source": [
-      "ReplaceMePIDCommand.cpp"
-    ],
-    "replacename": "ReplaceMePIDCommand",
-    "commandversion": 2
-  },
-  {
-    "name": "PIDSubsystem",
-    "description": "A subsystem that runs a PIDController.",
-    "tags": [
-      "pidsubsystem"
-    ],
-    "foldername": "pidsubsystem2",
-    "headers": [
-      "ReplaceMePIDSubsystem2.h"
-    ],
-    "source": [
-      "ReplaceMePIDSubsystem2.cpp"
-    ],
-    "replacename": "ReplaceMePIDSubsystem2",
-    "commandversion": 2
-  },
-  {
-    "name": "ProfiledPIDCommand",
-    "description": "A command that runs a ProfiledPIDController.",
-    "tags": [
-      "profiledpidcommand"
-    ],
-    "foldername": "profiledpidcommand",
-    "headers": [
-      "ReplaceMeProfiledPIDCommand.h"
-    ],
-    "source": [
-      "ReplaceMeProfiledPIDCommand.cpp"
-    ],
-    "replacename": "ReplaceMeProfiledPIDCommand",
-    "commandversion": 2
-  },
-  {
-    "name": "ProfiledPIDSubsystem",
-    "description": "A subsystem that runs a ProfiledPIDController.",
-    "tags": [
-      "profiledpidsubsystem"
-    ],
-    "foldername": "profiledpidsubsystem",
-    "headers": [
-      "ReplaceMeProfiledPIDSubsystem.h"
-    ],
-    "source": [
-      "ReplaceMeProfiledPIDSubsystem.cpp"
-    ],
-    "replacename": "ReplaceMeProfiledPIDSubsystem",
-    "commandversion": 2
-  },
   {
     "name": "SequentialCommandGroup",
     "description": "A command group that runs commands in sequence.",
@@ -190,21 +126,5 @@
     ],
     "replacename": "ReplaceMeSubsystem2",
     "commandversion": 2
-  },
-  {
-    "name": "TrapezoidProfileSubsystem",
-    "description": "A subsystem that executes a trapezoidal motion profile.",
-    "tags": [
-      "trapezoidprofilesubsystem"
-    ],
-    "foldername": "trapezoidprofilesubsystem",
-    "headers": [
-      "ReplaceMeTrapezoidProfileSubsystem.h"
-    ],
-    "source": [
-      "ReplaceMeTrapezoidProfileSubsystem.cpp"
-    ],
-    "replacename": "ReplaceMeTrapezoidProfileSubsystem",
-    "commandversion": 2
   }
 ]
diff --git a/wpilibcExamples/src/main/cpp/commands/instantcommand/ReplaceMeInstantCommand2.h b/wpilibcExamples/src/main/cpp/commands/instantcommand/ReplaceMeInstantCommand2.h
@@ -7,6 +7,9 @@
 #include <frc2/command/CommandHelper.h>
 #include <frc2/command/InstantCommand.h>
 
+// NOTE:  Consider using this command inline, rather than writing a subclass.  For more
+// information, see:
+// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
 class ReplaceMeInstantCommand2
     : public frc2::CommandHelper<frc2::InstantCommand,
                                  ReplaceMeInstantCommand2> {

diff --git a/wpilibcExamples/src/main/cpp/commands/parallelcommandgroup/ReplaceMeParallelCommandGroup.h b/wpilibcExamples/src/main/cpp/commands/parallelcommandgroup/ReplaceMeParallelCommandGroup.h
@@ -7,6 +7,9 @@
 #include <frc2/command/CommandHelper.h>
 #include <frc2/command/ParallelCommandGroup.h>
 
+// NOTE:  Consider using this command inline, rather than writing a subclass.  For more
+// information, see:
+// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
 class ReplaceMeParallelCommandGroup
     : public frc2::CommandHelper<frc2::ParallelCommandGroup,
                                  ReplaceMeParallelCommandGroup> {

diff --git a/wpilibcExamples/src/main/cpp/commands/paralleldeadlinegroup/ReplaceMeParallelDeadlineGroup.h b/wpilibcExamples/src/main/cpp/commands/paralleldeadlinegroup/ReplaceMeParallelDeadlineGroup.h
@@ -7,6 +7,9 @@
 #include <frc2/command/CommandHelper.h>
 #include <frc2/command/ParallelDeadlineGroup.h>
 
+// NOTE:  Consider using this command inline, rather than writing a subclass.  For more
+// information, see:
+// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
 class ReplaceMeParallelDeadlineGroup
     : public frc2::CommandHelper<frc2::ParallelDeadlineGroup,
                                  ReplaceMeParallelDeadlineGroup> {

diff --git a/wpilibcExamples/src/main/cpp/commands/parallelracegroup/ReplaceMeParallelRaceGroup.h b/wpilibcExamples/src/main/cpp/commands/parallelracegroup/ReplaceMeParallelRaceGroup.h
@@ -7,6 +7,9 @@
 #include <frc2/command/CommandHelper.h>
 #include <frc2/command/ParallelRaceGroup.h>
 
+// NOTE:  Consider using this command inline, rather than writing a subclass.  For more
+// information, see:
+// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
 class ReplaceMeParallelRaceGroup
     : public frc2::CommandHelper<frc2::ParallelRaceGroup,
                                  ReplaceMeParallelRaceGroup> {

diff --git a/wpilibcExamples/src/main/cpp/commands/pidcommand/ReplaceMePIDCommand.cpp b/wpilibcExamples/src/main/cpp/commands/pidcommand/ReplaceMePIDCommand.cpp
diff --git a/wpilibcExamples/src/main/cpp/commands/pidcommand/ReplaceMePIDCommand.h b/wpilibcExamples/src/main/cpp/commands/pidcommand/ReplaceMePIDCommand.h
diff --git a/wpilibcExamples/src/main/cpp/commands/pidsubsystem2/ReplaceMePIDSubsystem2.cpp b/wpilibcExamples/src/main/cpp/commands/pidsubsystem2/ReplaceMePIDSubsystem2.cpp
diff --git a/wpilibcExamples/src/main/cpp/commands/pidsubsystem2/ReplaceMePIDSubsystem2.h b/wpilibcExamples/src/main/cpp/commands/pidsubsystem2/ReplaceMePIDSubsystem2.h
diff --git a/wpilibcExamples/src/main/cpp/commands/profiledpidcommand/ReplaceMeProfiledPIDCommand.cpp b/wpilibcExamples/src/main/cpp/commands/profiledpidcommand/ReplaceMeProfiledPIDCommand.cpp
diff --git a/wpilibcExamples/src/main/cpp/commands/profiledpidcommand/ReplaceMeProfiledPIDCommand.h b/wpilibcExamples/src/main/cpp/commands/profiledpidcommand/ReplaceMeProfiledPIDCommand.h
diff --git a/wpilibcExamples/src/main/cpp/commands/profiledpidsubsystem/ReplaceMeProfiledPIDSubsystem.cpp b/wpilibcExamples/src/main/cpp/commands/profiledpidsubsystem/ReplaceMeProfiledPIDSubsystem.cpp
diff --git a/wpilibcExamples/src/main/cpp/commands/profiledpidsubsystem/ReplaceMeProfiledPIDSubsystem.h b/wpilibcExamples/src/main/cpp/commands/profiledpidsubsystem/ReplaceMeProfiledPIDSubsystem.h
diff --git a/...bcExamples/src/main/cpp/commands/sequentialcommandgroup/ReplaceMeSequentialCommandGroup.h b/...bcExamples/src/main/cpp/commands/sequentialcommandgroup/ReplaceMeSequentialCommandGroup.h
@@ -7,6 +7,9 @@
 #include <frc2/command/CommandHelper.h>
 #include <frc2/command/SequentialCommandGroup.h>
 
+// NOTE:  Consider using this command inline, rather than writing a subclass.  For more
+// information, see:
+// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
 class ReplaceMeSequentialCommandGroup
     : public frc2::CommandHelper<frc2::SequentialCommandGroup,
                                  ReplaceMeSequentialCommandGroup> {

diff --git a/...es/src/main/cpp/commands/trapezoidprofilesubsystem/ReplaceMeTrapezoidProfileSubsystem.cpp b/...es/src/main/cpp/commands/trapezoidprofilesubsystem/ReplaceMeTrapezoidProfileSubsystem.cpp
diff --git a/...ples/src/main/cpp/commands/trapezoidprofilesubsystem/ReplaceMeTrapezoidProfileSubsystem.h b/...ples/src/main/cpp/commands/trapezoidprofilesubsystem/ReplaceMeTrapezoidProfileSubsystem.h
diff --git a/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/commands/command2/ReplaceMeCommand.java b/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/commands/command2/ReplaceMeCommand.java
@@ -6,6 +6,7 @@
 
 import edu.wpi.first.wpilibj2.command.Command;
 
+/* You should consider using the more terse Command factories API instead https://docs.wpilib.org/en/stable/docs/software/commandbased/organizing-command-based.html#defining-commands */
 public class ReplaceMeCommand extends Command {
   /** Creates a new ReplaceMeCommand. */
   public ReplaceMeCommand() {