Gazebo Gazebo

API Reference

3.15.1
WindEffects.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_WINDEFFECTS_HH_
18 #define GZ_GAZEBO_SYSTEMS_WINDEFFECTS_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 WindEffectsPrivate;
34 
89  class WindEffects:
90  public System,
91  public ISystemConfigure,
92  public ISystemPreUpdate
93  {
95  public: WindEffects();
96 
98  public: ~WindEffects() final;
99 
100  // Documentation inherited
101  public: void Configure(const Entity &_entity,
104  EventManager &_eventMgr) final;
105 
106  // Documentation inherited
107  public: void PreUpdate(const UpdateInfo &_info,
108  EntityComponentManager &_ecm) final;
109 
111  private: std::unique_ptr<WindEffectsPrivate> dataPtr;
112  };
113  }
114 }
115 }
116 }
117 #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.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:65
STL class.
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:50
A system that simulates a simple wind model. The wind is described as a uniform worldwide model....
Definition: WindEffects.hh:89
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:37
void PreUpdate(const UpdateInfo &_info, EntityComponentManager &_ecm) final
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:105
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:88
Base class for a System.
Definition: gz/sim/System.hh:73
void Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
Configure the system.