MechanismGearing.hpp

Go to the documentation of this file.

// Copyright (c) 2026 Yet Another Software Suite
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <optional>
 
#include "GearBox.hpp"
#include "Sprocket.hpp"
 
namespace yams::gearing {
 
class MechanismGearing {
 public:
  static const MechanismGearing kOne;
 
  explicit MechanismGearing(double reductionRatio);
 
  explicit MechanismGearing(const GearBox& gearBox);
 
  MechanismGearing(const GearBox& gearBox, const Sprocket& sprockets);
 
  double GetRotorToMechanismRatio() const;
 
  double GetMechanismToRotorRatio() const;
 
  MechanismGearing& Div(double i);
 
 private:
  GearBox m_gearBox;
  std::optional<Sprocket> m_sprockets;
};
 
}  // namespace yams::gearing