Ignition Gazebo

API Reference

3.5.0
src/systems/altimeter/Altimeter.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_ALTIMETER_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_ALTIMETER_HH_
19 
20 #include <memory>
21 #include <ignition/gazebo/config.hh>
22 #include <ignition/gazebo/Export.hh>
24 
25 namespace ignition
26 {
27 namespace gazebo
28 {
29 // Inline bracket to help doxygen filtering.
30 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
31 namespace systems
32 {
33  // Forward declarations.
34  class AltimeterPrivate;
35 
39  class IGNITION_GAZEBO_VISIBLE Altimeter:
40  public System,
41  public ISystemPreUpdate,
42  public ISystemPostUpdate
43  {
45  public: explicit Altimeter();
46 
48  public: ~Altimeter() override;
49 
51  public: void PreUpdate(const UpdateInfo &_info,
52  EntityComponentManager &_ecm) final;
53 
54 
56  public: void PostUpdate(const UpdateInfo &_info,
57  const EntityComponentManager &_ecm) final;
58 
60  private: std::unique_ptr<AltimeterPrivate> dataPtr;
61  };
62  }
63 }
64 }
65 }
66 #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:37
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:64
An altimeter sensor that reports vertical position and velocity readings over ign transport...
Definition: src/systems/altimeter/Altimeter.hh:39
Component< sdf::Sensor, class AltimeterTag, serializers::SensorSerializer > Altimeter
A component type that contains an altimeter sensor, sdf::Altimeter, information.
Definition: include/ignition/gazebo/components/Altimeter.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