Gazebo Gazebo

API Reference

3.15.1
gz/sim/Events.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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_EVENTS_HH_
18 #define GZ_GAZEBO_EVENTS_HH_
19 
20 #include <sdf/Element.hh>
21 
22 #include <gz/common/Event.hh>
23 
24 #include "gz/sim/config.hh"
25 #include "gz/sim/Entity.hh"
26 
27 namespace ignition
28 {
29  namespace gazebo
30  {
31  // Inline bracket to help doxygen filtering.
32  inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
35  namespace events
36  {
45  using Pause = gz::common::EventT<void(bool), struct PauseTag>;
46 
54  using Stop = gz::common::EventT<void(void), struct StopTag>;
55 
59  using LoadPlugins = common::EventT<void(Entity, sdf::ElementPtr),
60  struct LoadPluginsTag>;
61  }
62  } // namespace events
63  } // namespace gazebo
64 } // namespace ignition
65 
66 #endif // GZ_GAZEBO_EVENTS_HH_
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.
gz::common::EventT< void(bool), struct PauseTag > Pause
The pause event can be used to pause or unpause simulation. Emit a value of true to pause simulation,...
Definition: gz/sim/Events.hh:45
gz::common::EventT< void(void), struct StopTag > Stop
The stop event can be used to terminate simulation. Emit this signal to terminate an active simulatio...
Definition: gz/sim/Events.hh:54