Ignition Gazebo

API Reference

3.5.0
LogPlayback.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 IGNITION_GAZEBO_SYSTEMS_LOGPLAYBACK_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_LOGPLAYBACK_HH_
19 
20 #include <memory>
21 
22 #include <ignition/gazebo/config.hh>
23 #include <ignition/gazebo/Export.hh>
25 
26 namespace ignition
27 {
28 namespace gazebo
29 {
30 // Inline bracket to help doxygen filtering.
31 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
32 namespace systems
33 {
34  // Forward declarations.
35  class LogPlaybackPrivate;
36 
40  class IGNITION_GAZEBO_VISIBLE LogPlayback:
41  public System,
42  public ISystemConfigure,
43  public ISystemUpdate
44  {
46  public: explicit LogPlayback();
47 
49  public: ~LogPlayback() override;
50 
52  public: void Configure(const Entity &_id,
55  EventManager &_eventMgr) final;
56 
58  public: void Update(const UpdateInfo &_info,
59  EntityComponentManager &_ecm) final;
60 
62  private: std::unique_ptr<LogPlaybackPrivate> dataPtr;
63  };
64  }
65 }
66 }
67 }
68 #endif
Log state playback.
Definition: LogPlayback.hh:40
Interface for a system that uses the Update phase.
Definition: System.hh:112
Information passed to systems on the update callback.
Definition: Types.hh:37
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:64
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:50
Interface for a system that implements optional configuration.
Definition: System.hh:88
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59
Base class for a System.
Definition: System.hh:73