Gazebo Gazebo

API Reference

6.16.0
Hydrodynamics.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 IGNITION_GAZEBO_SYSTEMS_HYDRODYNAMICS_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_HYDRODYNAMICS_HH_
19 
20 #include <gz/sim/System.hh>
21 #include <memory>
22 
23 namespace ignition
24 {
25 namespace gazebo
26 {
27 // Inline bracket to help doxygen filtering.
28 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
29 namespace systems
30 {
31  class HydrodynamicsPrivateData;
32 
140  {
142  public: Hydrodynamics();
143 
145  public: ~Hydrodynamics() override;
146 
148  public: void Configure(
149  const ignition::gazebo::Entity &_entity,
152  ignition::gazebo::EventManager &/*_eventMgr*/) override;
153 
155  public: void PreUpdate(
156  const ignition::gazebo::UpdateInfo &_info,
158 
161  };
162 }
163 }
164 }
165 }
166 #endif
This class provides hydrodynamic behaviour for underwater vehicles It is shamelessly based off Brian ...
Definition: Hydrodynamics.hh:136
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light....
Definition: gz/sim/Entity.hh:58
This library is part of the Gazebo project.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:66
STL class.
void PreUpdate(const ignition::gazebo::UpdateInfo &_info, ignition::gazebo::EntityComponentManager &_ecm) override
Documentation inherited.
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:54
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:38
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:121
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:90
Base class for a System.
Definition: gz/sim/System.hh:75
void Configure(const ignition::gazebo::Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, ignition::gazebo::EntityComponentManager &_ecm, ignition::gazebo::EventManager &) override
Documentation inherited.