LinearSystemSim.h

Go to the documentation of this file.

// 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 <array>
 
#include <units/current.h>
#include <units/time.h>
 
#include "frc/EigenCore.h"
#include "frc/StateSpaceUtil.h"
#include "frc/system/LinearSystem.h"
 
namespace frc::sim {
/**
 * This class helps simulate linear systems. To use this class, do the following
 * in the simulationPeriodic() method.
 *
 * Call the SetInput() method with the inputs to your system (generally
 * voltage). Call the Update() method to update the simulation. Set simulated
 * sensor readings with the simulated positions in the GetOutput() method.
 *
 * @tparam States  Number of states of the system.
 * @tparam Inputs  Number of inputs to the system.
 * @tparam Outputs Number of outputs of the system.
 */
template <int States, int Inputs, int Outputs>
class LinearSystemSim {
 public:
  /**
   * Creates a simulated generic linear system.
   *
   * @param system             The system to simulate.
   * @param measurementStdDevs The standard deviations of the measurements.
   */
  explicit LinearSystemSim(
      const LinearSystem<States, Inputs, Outputs>& system,
      const std::array<double, Outputs>& measurementStdDevs = {})
      : m_plant(system), m_measurementStdDevs(measurementStdDevs) {
    m_x = Vectord<States>::Zero();
    m_y = Vectord<Outputs>::Zero();
    m_u = Vectord<Inputs>::Zero();
  }
 
  virtual ~LinearSystemSim() = default;
 
  /**
   * Updates the simulation.
   *
   * @param dt The time between updates.
   */
  void Update(units::second_t dt) {
    // Update x. By default, this is the linear system dynamics x_k+1 = Ax_k +
    // Bu_k
    m_x = UpdateX(m_x, m_u, dt);
 
    // y = Cx + Du
    m_y = m_plant.CalculateY(m_x, m_u);
 
    // Add noise. If the user did not pass a noise vector to the
    // constructor, then this method will not do anything because
    // the standard deviations default to zero.
    m_y += frc::MakeWhiteNoiseVector<Outputs>(m_measurementStdDevs);
  }
 
  /**
   * Returns the current output of the plant.
   *
   * @return The current output of the plant.
   */
  const Vectord<Outputs>& GetOutput() const { return m_y; }
 
  /**
   * Returns an element of the current output of the plant.
   *
   * @param row The row to return.
   * @return An element of the current output of the plant.
   */
  double GetOutput(int row) const { return m_y(row); }
 
  /**
   * Sets the system inputs (usually voltages).
   *
   * @param u The system inputs.
   */
  void SetInput(const Vectord<Inputs>& u) { m_u = u; }
 
  /**
   * Sets the system inputs.
   *
   * @param row   The row in the input matrix to set.
   * @param value The value to set the row to.
   */
  void SetInput(int row, double value) { m_u(row, 0) = value; }
 
  /**
   * Returns the current input of the plant.
   *
   * @return The current input of the plant.
   */
  const Vectord<Inputs>& GetInput() const { return m_u; }
 
  /**
   * Returns an element of the current input of the plant.
   *
   * @param row The row to return.
   * @return An element of the current input of the plant.
   */
  double GetInput(int row) const { return m_u(row); }
 
  /**
   * Sets the system state.
   *
   * @param state The new state.
   */
  void SetState(const Vectord<States>& state) { m_x = state; }
 
 protected:
  /**
   * Updates the state estimate of the system.
   *
   * @param currentXhat The current state estimate.
   * @param u           The system inputs (usually voltage).
   * @param dt          The time difference between controller updates.
   */
  virtual Vectord<States> UpdateX(const Vectord<States>& currentXhat,
                                  const Vectord<Inputs>& u,
                                  units::second_t dt) {
    return m_plant.CalculateX(currentXhat, u, dt);
  }
 
  /**
   * Clamp the input vector such that no element exceeds the given voltage. If
   * any does, the relative magnitudes of the input will be maintained.
   *
   * @param maxInput The maximum magnitude of the input vector after clamping.
   */
  void ClampInput(double maxInput) {
    m_u = frc::DesaturateInputVector<Inputs>(m_u, maxInput);
  }
 
  /// The plant that represents the linear system.
  LinearSystem<States, Inputs, Outputs> m_plant;
 
  /// State vector.
  Vectord<States> m_x;
 
  /// Input vector.
  Vectord<Inputs> m_u;
 
  /// Output vector.
  Vectord<Outputs> m_y;
 
  /// The standard deviations of measurements, used for adding noise to the
  /// measurements.
  std::array<double, Outputs> m_measurementStdDevs;
};
}  // namespace frc::sim