Ignition Gazebo

API Reference

6.0.0~pre1
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 IGNITION_GAZEBO_SYSTEMS_KINETIC_ENERGY_MONITOR_HH_
19 #define IGNITION_GAZEBO_SYSTEMS_KINETIC_ENERGY_MONITOR_HH_
20 
21 #include <memory>
22 #include <ignition/gazebo/config.hh>
23 #include <ignition/gazebo/Export.hh>
25 
26 namespace ignition
27 {
28 namespace gazebo
29 {
30 // Inline bracket to help doxygen filtering.
31 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
32 namespace systems
33 {
34  // Forward declarations.
35  class KineticEnergyMonitorPrivate;
36 
57 
101  public System,
102  public ISystemConfigure,
103  public ISystemPostUpdate
104  {
106  public: KineticEnergyMonitor();
107 
109  public: ~KineticEnergyMonitor() final;
110 
111  // Documentation inherited
112  public: void Configure(const Entity &_entity,
115  EventManager &_eventMgr) final;
116 
117  // Documentation inherited
118  public: void PostUpdate(const UpdateInfo &_info,
119  const EntityComponentManager &_ecm) final;
120 
123  };
124 }
125 }
126 }
127 }
128 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:119
Information passed to systems on the update callback.
Definition: Types.hh:38
A system that monitors the kinetic energy of a link in a model and publishes when there is a lost of ...
Definition: KineticEnergyMonitor.hh:100
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:66
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:54
Interface for a system that implements optional configuration.
Definition: System.hh:88
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59
Base class for a System.
Definition: System.hh:73