Gazebo Sim

API Reference

8.7.0
KineticEnergyMonitor.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef GZ_SIM_SYSTEMS_KINETIC_ENERGY_MONITOR_HH_
19 #define GZ_SIM_SYSTEMS_KINETIC_ENERGY_MONITOR_HH_
20 
21 #include <memory>
22 #include <gz/sim/config.hh>
23 #include <gz/sim/Export.hh>
24 #include <gz/sim/System.hh>
25 
26 namespace gz
27 {
28 namespace sim
29 {
30 // Inline bracket to help doxygen filtering.
31 inline namespace GZ_SIM_VERSION_NAMESPACE {
32 namespace systems
33 {
34  // Forward declarations.
35  class KineticEnergyMonitorPrivate;
36 
57 
100  class KineticEnergyMonitor final:
101  public System,
102  public ISystemConfigure,
103  public ISystemPostUpdate
104  {
107 
109  public: ~KineticEnergyMonitor() final;
110 
111  // Documentation inherited
112  public: void Configure(const Entity &_entity,
113  const std::shared_ptr<const sdf::Element> &_sdf,
115  EventManager &_eventMgr) final;
116 
117  // Documentation inherited
118  public: void PostUpdate(const UpdateInfo &_info,
119  const EntityComponentManager &_ecm) final;
120 
122  private: std::unique_ptr<KineticEnergyMonitorPrivate> dataPtr;
123  };
124 }
125 }
126 }
127 }
128 #endif