Gazebo Gazebo

API Reference

6.16.0
Elevator.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 
18 /*
19  * \author Nick Lamprianidis <nlamprian@gmail.com>
20  * \date January 2021
21  */
22 
23 #ifndef GZ_GAZEBO_SYSTEMS_ELEVATOR_HH_
24 #define GZ_GAZEBO_SYSTEMS_ELEVATOR_HH_
25 
26 #include <memory>
27 
28 #include <gz/sim/System.hh>
29 
30 namespace ignition
31 {
32 namespace gazebo
33 {
34 // Inline bracket to help doxygen filtering
35 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
36 namespace systems
37 {
38 // Data forward declaration
39 class ElevatorPrivate;
40 
104 class IGNITION_GAZEBO_VISIBLE Elevator : public System,
105  public ISystemConfigure,
106  public ISystemPostUpdate
107 {
109  public: Elevator();
110 
112  public: ~Elevator() override = default;
113 
114  // Documentation inherited
115  public: void Configure(const Entity &_entity,
118  EventManager &_eventMgr) override;
119 
120  // Documentation inherited
121  public: void PostUpdate(const UpdateInfo &_info,
122  const EntityComponentManager &_ecm) override;
123 
125  private: std::shared_ptr<ElevatorPrivate> dataPtr;
126 };
127 
128 } // namespace systems
129 } // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
130 } // namespace gazebo
131 } // namespace ignition
132 
133 #endif // GZ_GAZEBO_SYSTEMS_ELEVATOR_HH_
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 PostUpdate(const UpdateInfo &_info, const EntityComponentManager &_ecm) override
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 Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
Configure the system.
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
~Elevator() override=default
Destructor.
System that controls an elevator. It closely models the structure and functionality of a real elevato...
Definition: Elevator.hh:104