Gazebo Gazebo

API Reference

3.15.1
TrackController.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 GZ_GAZEBO_SYSTEMS_TRACKCONTROLLER_HH_
18 #define GZ_GAZEBO_SYSTEMS_TRACKCONTROLLER_HH_
19 
20 #include <memory>
21 #include <gz/sim/System.hh>
22 #include "gz/sim/physics/Events.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 declaration
33  class TrackControllerPrivate;
34 
97  : public System,
98  public ISystemConfigure,
99  public ISystemPreUpdate
100  {
102  public: TrackController();
103 
105  public: ~TrackController() override;
106 
107  // Documentation inherited
108  public: void Configure(const Entity &_entity,
111  EventManager &_eventMgr) override;
112 
113  // Documentation inherited
114  public: void PreUpdate(
115  const gz::sim::UpdateInfo &_info,
116  gz::sim::EntityComponentManager &_ecm) override;
117 
120  };
121  }
122 }
123 }
124 }
125 
126 #endif
void PreUpdate(const gz::sim::UpdateInfo &_info, gz::sim::EntityComponentManager &_ecm) override
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
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:37
Controller of a track on either a conveyor belt or a tracked vehicle. The system should be attached t...
Definition: TrackController.hh:96
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) override
Configure the system.