Gazebo Gazebo

API Reference

3.15.1
Sensors.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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_SENSORS_HH_
18 #define GZ_GAZEBO_SYSTEMS_SENSORS_HH_
19 
20 #include <memory>
21 #include <string>
22 
23 #include <gz/sim/config.hh>
24 #include <gz/sim/System.hh>
25 #include <sdf/Sensor.hh>
26 
27 namespace ignition
28 {
29 namespace gazebo
30 {
31 // Inline bracket to help doxygen filtering.
32 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
33 namespace systems
34 {
35  // Forward declarations.
36  class SensorsPrivate;
37 
53  class Sensors:
54  public System,
55  public ISystemConfigure,
56  public ISystemPostUpdate
57  {
59  public: explicit Sensors();
60 
62  public: ~Sensors() override;
63 
64  // Documentation inherited
65  public: void Configure(const Entity &_id,
68  EventManager &_eventMgr) final;
69 
70  // Documentation inherited
71  public: void PostUpdate(const UpdateInfo &_info,
72  const EntityComponentManager &_ecm) final;
73 
78  private : std::string CreateSensor(const sdf::Sensor &_sdf,
79  const std::string &_parentName);
80 
82  private: std::unique_ptr<SensorsPrivate> dataPtr;
83  };
84  }
85 }
86 }
87 }
88 #endif
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light....
Definition: gz/sim/Entity.hh:59
This library is part of the Ignition Robotics project.
STL class.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:65
STL class.
void PostUpdate(const UpdateInfo &_info, const EntityComponentManager &_ecm) final
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:50
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:37
Interface for a system that uses the PostUpdate phase.
Definition: gz/sim/System.hh:119
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:88
A system that manages sensors.
Definition: Sensors.hh:53
void Configure(const Entity &_id, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
Configure the system.
Base class for a System.
Definition: gz/sim/System.hh:73
Component< NoData, class SensorTag > Sensor
A component that identifies an entity as being a sensor.
Definition: gz/sim/components/Sensor.hh:35