Gazebo Gazebo

API Reference

3.15.1
src/systems/imu/Imu.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 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 #ifndef GZ_GAZEBO_SYSTEMS_IMU_HH_
18 #define GZ_GAZEBO_SYSTEMS_IMU_HH_
19 
20 #include <memory>
21 #include <gz/sim/config.hh>
22 #include <gz/sim/System.hh>
23 
24 namespace ignition
25 {
26 namespace gazebo
27 {
28 // Inline bracket to help doxygen filtering.
29 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
30 namespace systems
31 {
32  // Forward declarations.
33  class ImuPrivate;
34 
39  class Imu:
40  public System,
41  public ISystemPreUpdate,
42  public ISystemPostUpdate
43  {
45  public: explicit Imu();
46 
48  public: ~Imu() override;
49 
51  public: void PreUpdate(const UpdateInfo &_info,
52  EntityComponentManager &_ecm) final;
53 
55  public: void PostUpdate(const UpdateInfo &_info,
56  const EntityComponentManager &_ecm) final;
57 
59  private: std::unique_ptr<ImuPrivate> dataPtr;
60  };
61  }
62 }
63 }
64 }
65 #endif
Component< sdf::Sensor, class ImuTag, serializers::SensorSerializer > Imu
A component type that contains an IMU sensor, sdf::IMU, information.
Definition: include/gz/sim/components/Imu.hh:40
This library is part of the Ignition Robotics project.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:65
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:37
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:105
Interface for a system that uses the PostUpdate phase.
Definition: gz/sim/System.hh:119
Base class for a System.
Definition: gz/sim/System.hh:73
void PostUpdate(const UpdateInfo &_info, const EntityComponentManager &_ecm) final
Documentation inherited.
void PreUpdate(const UpdateInfo &_info, EntityComponentManager &_ecm) final
Documentation inherited.
This system manages all IMU sensors in simulation. Each IMU sensor eports vertical position,...
Definition: src/systems/imu/Imu.hh:39