mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
8f1f64ffb6
Also update copyright to include "and other WPILib contributors" and clarify license referral language to not be restricted to FIRST teams.
112 lines
4.0 KiB
C++
112 lines
4.0 KiB
C++
// 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 <functional>
|
|
#include <initializer_list>
|
|
|
|
#include <frc/controller/PIDController.h>
|
|
|
|
#include "frc2/command/CommandBase.h"
|
|
#include "frc2/command/CommandHelper.h"
|
|
|
|
namespace frc2 {
|
|
/**
|
|
* A command that controls an output with a PIDController. Runs forever by
|
|
* default - to add exit conditions and/or other behavior, subclass this class.
|
|
* The controller calculation and output are performed synchronously in the
|
|
* command's execute() method.
|
|
*
|
|
* @see PIDController
|
|
*/
|
|
class PIDCommand : public CommandHelper<CommandBase, PIDCommand> {
|
|
public:
|
|
/**
|
|
* Creates a new PIDCommand, which controls the given output with a
|
|
* PIDController.
|
|
*
|
|
* @param controller the controller that controls the output.
|
|
* @param measurementSource the measurement of the process variable
|
|
* @param setpointSource the controller's reference (aka setpoint)
|
|
* @param useOutput the controller's output
|
|
* @param requirements the subsystems required by this command
|
|
*/
|
|
PIDCommand(PIDController controller,
|
|
std::function<double()> measurementSource,
|
|
std::function<double()> setpointSource,
|
|
std::function<void(double)> useOutput,
|
|
std::initializer_list<Subsystem*> requirements);
|
|
|
|
/**
|
|
* Creates a new PIDCommand, which controls the given output with a
|
|
* PIDController.
|
|
*
|
|
* @param controller the controller that controls the output.
|
|
* @param measurementSource the measurement of the process variable
|
|
* @param setpointSource the controller's reference (aka setpoint)
|
|
* @param useOutput the controller's output
|
|
* @param requirements the subsystems required by this command
|
|
*/
|
|
PIDCommand(PIDController controller,
|
|
std::function<double()> measurementSource,
|
|
std::function<double()> setpointSource,
|
|
std::function<void(double)> useOutput,
|
|
wpi::ArrayRef<Subsystem*> requirements = {});
|
|
|
|
/**
|
|
* Creates a new PIDCommand, which controls the given output with a
|
|
* PIDController with a constant setpoint.
|
|
*
|
|
* @param controller the controller that controls the output.
|
|
* @param measurementSource the measurement of the process variable
|
|
* @param setpoint the controller's setpoint (aka setpoint)
|
|
* @param useOutput the controller's output
|
|
* @param requirements the subsystems required by this command
|
|
*/
|
|
PIDCommand(PIDController controller,
|
|
std::function<double()> measurementSource, double setpoint,
|
|
std::function<void(double)> useOutput,
|
|
std::initializer_list<Subsystem*> requirements);
|
|
|
|
/**
|
|
* Creates a new PIDCommand, which controls the given output with a
|
|
* PIDController with a constant setpoint.
|
|
*
|
|
* @param controller the controller that controls the output.
|
|
* @param measurementSource the measurement of the process variable
|
|
* @param setpoint the controller's setpoint (aka setpoint)
|
|
* @param useOutput the controller's output
|
|
* @param requirements the subsystems required by this command
|
|
*/
|
|
PIDCommand(PIDController controller,
|
|
std::function<double()> measurementSource, double setpoint,
|
|
std::function<void(double)> useOutput,
|
|
wpi::ArrayRef<Subsystem*> requirements = {});
|
|
|
|
PIDCommand(PIDCommand&& other) = default;
|
|
|
|
PIDCommand(const PIDCommand& other) = default;
|
|
|
|
void Initialize() override;
|
|
|
|
void Execute() override;
|
|
|
|
void End(bool interrupted) override;
|
|
|
|
/**
|
|
* Returns the PIDController used by the command.
|
|
*
|
|
* @return The PIDController
|
|
*/
|
|
PIDController& GetController();
|
|
|
|
protected:
|
|
PIDController m_controller;
|
|
std::function<double()> m_measurement;
|
|
std::function<double()> m_setpoint;
|
|
std::function<void(double)> m_useOutput;
|
|
};
|
|
} // namespace frc2
|