Ignition Gazebo

API Reference

5.0.0
LogRecord.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_LOGRECORD_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_LOGRECORD_HH_
19 
20 #include <memory>
21 
22 #include <ignition/gazebo/config.hh>
24 
25 namespace ignition
26 {
27 namespace gazebo
28 {
29 // Inline bracket to help doxygen filtering.
30 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
31 namespace systems
32 {
33  // Forward declarations.
34  class LogRecordPrivate;
35 
38  class LogRecord:
39  public System,
40  public ISystemConfigure,
41  public ISystemPreUpdate,
42  public ISystemPostUpdate
43  {
45  public: explicit LogRecord();
46 
48  public: ~LogRecord() override;
49 
50  // Documentation inherited
51  public: void Configure(const Entity &_id,
54  EventManager &_eventMgr) final;
55 
57  public: void PreUpdate(const UpdateInfo &_info,
58  EntityComponentManager &_ecm) final;
59 
61  public: void PostUpdate(const UpdateInfo &_info,
62  const EntityComponentManager &_ecm) final;
63 
65  private: std::unique_ptr<LogRecordPrivate> dataPtr;
66  };
67  }
68 }
69 }
70 }
71 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:119
Information passed to systems on the update callback.
Definition: Types.hh:36
Log state recorder.
Definition: LogRecord.hh:38
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:65
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:54
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
Interface for a system that uses the PreUpdate phase.
Definition: System.hh:105
Base class for a System.
Definition: System.hh:73