// 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 #ifdef _WIN32 #pragma warning(push) #pragma warning(disable : 4521) #endif #include #include #include #include #include #include #include #include #include "frc2/command/CommandBase.h" #include "frc2/command/PrintCommand.h" namespace frc2 { /** * A command composition that runs one of a selection of commands, either using * a selector and a key to command mapping, or a supplier that returns the * command directly at runtime. * *

The rules for command compositions apply: command instances that are * passed to it are owned by the composition and cannot be added to any other * composition or scheduled individually, and the composition requires all * subsystems its components require. * * This class is provided by the NewCommands VendorDep */ template class SelectCommand : public CommandHelper> { public: /** * Creates a new SelectCommand. * * @param commands the map of commands to choose from * @param selector the selector to determine which command to run */ template ... Commands> explicit SelectCommand(std::function selector, std::pair... commands) : m_selector{std::move(selector)} { std::vector>> foo; ((void)foo.emplace_back( commands.first, std::make_unique>(std::move(commands.second))), ...); for (auto&& command : foo) { CommandScheduler::GetInstance().RequireUngrouped(command.second.get()); } for (auto&& command : foo) { this->AddRequirements(command.second->GetRequirements()); m_runsWhenDisabled &= command.second->RunsWhenDisabled(); if (command.second->GetInterruptionBehavior() == Command::InterruptionBehavior::kCancelSelf) { m_interruptBehavior = Command::InterruptionBehavior::kCancelSelf; } m_commands.emplace(std::move(command.first), std::move(command.second)); } } SelectCommand( std::function selector, std::vector>>&& commands) : m_selector{std::move(selector)} { for (auto&& command : commands) { CommandScheduler::GetInstance().RequireUngrouped(command.second.get()); } for (auto&& command : commands) { this->AddRequirements(command.second->GetRequirements()); m_runsWhenDisabled &= command.second->RunsWhenDisabled(); if (command.second->GetInterruptionBehavior() == Command::InterruptionBehavior::kCancelSelf) { m_interruptBehavior = Command::InterruptionBehavior::kCancelSelf; } m_commands.emplace(std::move(command.first), std::move(command.second)); } } // No copy constructors for command groups SelectCommand(const SelectCommand& other) = delete; // Prevent template expansion from emulating copy ctor SelectCommand(SelectCommand&) = delete; /** * 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 toRun) : m_toRun{std::move(toRun)} {} SelectCommand(SelectCommand&& other) = default; void Initialize() override; void Execute() override { m_selectedCommand->Execute(); } void End(bool interrupted) override { return m_selectedCommand->End(interrupted); } bool IsFinished() override { return m_selectedCommand->IsFinished(); } bool RunsWhenDisabled() const override { return m_runsWhenDisabled; } Command::InterruptionBehavior GetInterruptionBehavior() const override { return m_interruptBehavior; } void InitSendable(wpi::SendableBuilder& builder) override { CommandBase::InitSendable(builder); builder.AddStringProperty( "selected", [this] { if (m_selectedCommand) { return m_selectedCommand->GetName(); } else { return std::string{"null"}; } }, nullptr); } protected: std::unique_ptr TransferOwnership() && override { return std::make_unique(std::move(*this)); } private: std::unordered_map> m_commands; std::function m_selector; std::function m_toRun; Command* m_selectedCommand; bool m_runsWhenDisabled = true; Command::InterruptionBehavior m_interruptBehavior{ Command::InterruptionBehavior::kCancelIncoming}; }; template void SelectCommand::Initialize() { if (m_selector) { auto find = m_commands.find(m_selector()); if (find == m_commands.end()) { m_selectedCommand = new PrintCommand( "SelectCommand selector value does not correspond to any command!"); return; } m_selectedCommand = find->second.get(); } else { m_selectedCommand = m_toRun(); } m_selectedCommand->Initialize(); } } // namespace frc2 #ifdef _WIN32 #pragma warning(pop) #endif