Gazebo Sim

API Reference

7.9.0
UserCommands.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 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_SIM_SYSTEMS_USERCOMMANDS_HH_
18 #define GZ_SIM_SYSTEMS_USERCOMMANDS_HH_
19 
20 #include <memory>
21 #include <gz/sim/config.hh>
22 #include <gz/sim/System.hh>
23 
24 namespace gz
25 {
26 namespace sim
27 {
28 // Inline bracket to help doxygen filtering.
29 inline namespace GZ_SIM_VERSION_NAMESPACE {
30 namespace systems
31 {
32  // Forward declarations.
33  class UserCommandsPrivate;
34 
73  class UserCommands final:
74  public System,
75  public ISystemConfigure,
76  public ISystemPreUpdate
77  {
79  public: explicit UserCommands();
80 
82  public: ~UserCommands() final;
83 
84  // Documentation inherited
85  public: void Configure(const Entity &_entity,
88  EventManager &_eventMgr) override;
89 
95  public: void PreUpdate(const UpdateInfo &_info,
96  EntityComponentManager &_ecm) final;
97 
99  private: std::unique_ptr<UserCommandsPrivate> dataPtr;
100  };
101  }
102 }
103 }
104 }
105 #endif