Gazebo Sim

API Reference

8.15.0
OdometryPublisher.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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_SIM_SYSTEMS_ODOMETRYPUBLISHER_HH_
18 #define GZ_SIM_SYSTEMS_ODOMETRYPUBLISHER_HH_
19 
20 #include <memory>
21 
22 #include <gz/sim/System.hh>
23 
24 namespace gz
25 {
26 namespace sim
27 {
28 // Inline bracket to help doxygen filtering.
29 inline namespace GZ_SIM_VERSION_NAMESPACE {
30 namespace systems
31 {
32  // Forward declaration
33  class OdometryPublisherPrivate;
34 
42  // odometry message. This element is optional, and the default value
93  : public System,
94  public ISystemConfigure,
95  public ISystemPreUpdate,
96  public ISystemPostUpdate
97  {
99  public: OdometryPublisher();
100 
102  public: ~OdometryPublisher() override = default;
103 
104  // Documentation inherited
105  public: void Configure(const Entity &_entity,
108  EventManager &_eventMgr) override;
109 
110  // Documentation inherited
111  public: void PreUpdate(
112  const gz::sim::UpdateInfo &_info,
113  gz::sim::EntityComponentManager &_ecm) override;
114 
115  // Documentation inherited
116  public: void PostUpdate(
117  const UpdateInfo &_info,
118  const EntityComponentManager &_ecm) override;
119 
122  };
123  }
124 }
125 }
126 }
127 
128 #endif