Gazebo Gazebo

API Reference

6.16.0
Thruster.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_THRUSTER_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_THRUSTER_HH_
19 
20 #include <gz/sim/System.hh>
21 
22 #include <memory>
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 declaration
33  class ThrusterPrivateData;
34 
109  class Thruster:
110  public System,
111  public ISystemConfigure,
112  public ISystemPreUpdate,
113  public ISystemPostUpdate
114  {
116  public: Thruster();
117 
119  public: void Configure(
120  const Entity &_entity,
123  EventManager &/*_eventMgr*/) override;
124 
126  public: void PreUpdate(
127  const ignition::gazebo::UpdateInfo &_info,
129 
131  public: void PostUpdate(const UpdateInfo &_info,
132  const EntityComponentManager &_ecm) override;
133 
135  private: std::unique_ptr<ThrusterPrivateData> dataPtr;
136  };
137 }
138 }
139 }
140 }
141 
142 #endif
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
void PostUpdate(const UpdateInfo &_info, const EntityComponentManager &_ecm) override
Documentation inherited.
This plugin simulates a maritime thruster for boats and underwater vehicles. It uses the equations de...
Definition: Thruster.hh:109
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:121
Interface for a system that uses the PostUpdate phase.
Definition: gz/sim/System.hh:135
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 Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &) override
Documentation inherited.