.. _program_listing_file__tmp_ws_src_rmf_battery_rmf_battery_include_rmf_battery_agv_MechanicalSystem.hpp:

Program Listing for File MechanicalSystem.hpp
=============================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_rmf_battery_rmf_battery_include_rmf_battery_agv_MechanicalSystem.hpp>` (``/tmp/ws/src/rmf_battery/rmf_battery/include/rmf_battery/agv/MechanicalSystem.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*
    * Copyright (C) 2020 Open Source Robotics Foundation
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software
    * distributed under the License is distributed on an "AS IS" BASIS,
    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    * See the License for the specific language governing permissions and
    * limitations under the License.
    *
   */
   
   #ifndef RMF_BATTERY__AGV__MECHANICALSYSTEM_HPP
   #define RMF_BATTERY__AGV__MECHANICALSYSTEM_HPP
   
   #include <rmf_utils/impl_ptr.hpp>
   
   #include <optional>
   
   namespace rmf_battery {
   namespace agv {
   
   class MechanicalSystem
   {
   public:
   
     static std::optional<MechanicalSystem> make(
       double mass,
       double moment_of_inertia,
       double friction_coefficient);
   
     double mass() const;
   
     double moment_of_inertia() const;
   
     double friction_coefficient() const;
   
     class Implementation;
   private:
     MechanicalSystem();
     rmf_utils::impl_ptr<Implementation> _pimpl;
   };
   
   using MechanicalSystemPtr = std::shared_ptr<MechanicalSystem>;
   using ConstMechanicalSystemPtr = std::shared_ptr<const MechanicalSystem>;
   
   } // namespace agv
   } // namespace rmf_battery
   
   #endif // RMF_BATTERY__AGV__MECHANICALSYSTEM_HPP