[commands] Refactor ProxyScheduleCommand, SelectCommand into ProxyCommand (#4534)

This commit is contained in:
Starlight220
2022-11-29 00:43:10 +02:00
committed by GitHub
parent e82cd5147b
commit 70080457d5
16 changed files with 214 additions and 43 deletions

View File

@@ -25,7 +25,6 @@ std::string GetTypeName(const T& type) {
}
class PerpetualCommand;
class ProxyScheduleCommand;
/**
* A state machine representing a complete action to be performed by the robot.
@@ -225,7 +224,7 @@ safe) semantics.
/**
* Decorates this command to run "by proxy" by wrapping it in a
* ProxyScheduleCommand. This is useful for "forking off" from command groups
* ProxyCommand. This is useful for "forking off" from command groups
* when the user does not wish to extend the command's requirements to the
* entire command group.
*

View File

@@ -49,7 +49,7 @@ class CommandPtr final {
/**
* Decorates this command to run "by proxy" by wrapping it in a
* ProxyScheduleCommand. This is useful for "forking off" from command groups
* ProxyCommand. This is useful for "forking off" from command groups
* when the user does not wish to extend the command's requirements to the
* entire command group.
*

View File

@@ -0,0 +1,68 @@
// 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.
#pragma once
#include <memory>
#include <span>
#include <wpi/FunctionExtras.h>
#include "frc2/command/CommandBase.h"
#include "frc2/command/CommandHelper.h"
#include "frc2/command/SetUtilities.h"
namespace frc2 {
/**
* Schedules the given command when this command is initialized, and ends when
* it ends. Useful for forking off from CommandGroups. If this command is
* interrupted, it will cancel the command.
*
* <p>This class is provided by the NewCommands VendorDep
*/
class ProxyCommand : public CommandHelper<CommandBase, ProxyCommand> {
public:
/**
* Creates a new ProxyCommand that schedules the supplied command when
* initialized, and ends when it is no longer scheduled. Useful for lazily
* creating commands at runtime.
*
* @param supplier the command supplier
*/
explicit ProxyCommand(wpi::unique_function<Command*()> supplier);
/**
* Creates a new ProxyCommand that schedules the given command when
* initialized, and ends when it is no longer scheduled.
*
* @param command the command to run by proxy
*/
explicit ProxyCommand(Command* command);
/**
* Creates a new ProxyCommand that schedules the given command when
* initialized, and ends when it is no longer scheduled.
*
* <p>Note that this constructor passes ownership of the given command to the
* returned ProxyCommand.
*
* @param command the command to schedule
*/
explicit ProxyCommand(std::unique_ptr<Command> command);
ProxyCommand(ProxyCommand&& other) = default;
void Initialize() override;
void End(bool interrupted) override;
void Execute() override;
bool IsFinished() override;
private:
wpi::unique_function<Command*()> m_supplier;
Command* m_command = nullptr;
};
} // namespace frc2

View File

@@ -8,6 +8,7 @@
#include <span>
#include <wpi/SmallVector.h>
#include <wpi/deprecated.h>
#include "frc2/command/CommandBase.h"
#include "frc2/command/CommandHelper.h"
@@ -30,22 +31,14 @@ class ProxyScheduleCommand
* initialized, and ends when they are all no longer scheduled.
*
* @param toSchedule the commands to schedule
* @deprecated Replace with {@link ProxyCommand},
* composing multiple of them in a {@link ParallelRaceGroup} if needed.
*/
WPI_DEPRECATED("Replace with ProxyCommand")
explicit ProxyScheduleCommand(std::span<Command* const> toSchedule);
explicit ProxyScheduleCommand(Command* toSchedule);
/**
* Creates a new ProxyScheduleCommand that schedules the given command when
* initialized, and ends when it is no longer scheduled.
*
* <p>Note that this constructor passes ownership of the given command to the
* returned ProxyScheduleCommand.
*
* @param toSchedule the command to schedule
*/
explicit ProxyScheduleCommand(std::unique_ptr<Command>&& toSchedule);
ProxyScheduleCommand(ProxyScheduleCommand&& other) = default;
void Initialize() override;

View File

@@ -108,7 +108,10 @@ class SelectCommand : public CommandHelper<CommandBase, SelectCommand<Key>> {
* Creates a new selectcommand.
*
* @param toRun a supplier providing the command to run
* @deprecated Replace with {@link ProxyCommand},
* composing multiple of them in a {@link ParallelRaceGroup} if needed.
*/
WPI_DEPRECATED("Replace with ProxyCommand")
explicit SelectCommand(std::function<Command*()> toRun)
: m_toRun{std::move(toRun)} {}