Ignition Gazebo

API Reference

5.0.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 
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 
117  {
119  public: Hydrodynamics();
120 
122  public: ~Hydrodynamics() override;
123 
125  public: void Configure(
126  const ignition::gazebo::Entity &_entity,
129  ignition::gazebo::EventManager &/*_eventMgr*/) override;
130 
132  public: void PreUpdate(
133  const ignition::gazebo::UpdateInfo &_info,
135 
138  };
139 }
140 }
141 }
142 }
143 #endif
Information passed to systems on the update callback.
Definition: Types.hh:36
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:65
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:54
This class provides hydrodynamic behaviour for underwater vehicles It is shamelessly based off Brian ...
Definition: Hydrodynamics.hh:113
Interface for a system that implements optional configuration.
Definition: System.hh:88
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59
Interface for a system that uses the PreUpdate phase.
Definition: System.hh:105
Base class for a System.
Definition: System.hh:73