Ignition Gazebo

API Reference

6.9.0
src/systems/magnetometer/Magnetometer.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 IGNITION_GAZEBO_SYSTEMS_MAGNETOMETER_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_MAGNETOMETER_HH_
19 
20 #include <memory>
21 #include <ignition/gazebo/config.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 MagnetometerPrivate;
34 
38  class Magnetometer:
39  public System,
40  public ISystemPreUpdate,
41  public ISystemPostUpdate
42  {
44  public: explicit Magnetometer();
45 
47  public: ~Magnetometer() override;
48 
50  public: void PreUpdate(const UpdateInfo &_info,
51  EntityComponentManager &_ecm) final;
52 
54  public: void PostUpdate(const UpdateInfo &_info,
55  const EntityComponentManager &_ecm) final;
56 
58  private: std::unique_ptr<MagnetometerPrivate> dataPtr;
59  };
60  }
61 }
62 }
63 }
64 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:119
Component< sdf::Sensor, class MagnetometerTag, serializers::SensorSerializer > Magnetometer
A component type that contains a magnetometer sensor, sdf::Magnetometer, information.
Definition: include/ignition/gazebo/components/Magnetometer.hh:40
Information passed to systems on the update callback.
Definition: include/ignition/gazebo/Types.hh:38
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
An magnetometer sensor that reports the magnetic field in its current location.
Definition: src/systems/magnetometer/Magnetometer.hh:38
This library is part of the Ignition Robotics project.
Interface for a system that uses the PreUpdate phase.
Definition: System.hh:105
Base class for a System.
Definition: System.hh:73