Ignition Gazebo

API Reference

6.9.0
System.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 IGNITION_GAZEBO_SYSTEM_HH_
18 #define IGNITION_GAZEBO_SYSTEM_HH_
19 
20 #include <memory>
21 
22 #include <ignition/gazebo/config.hh>
25 #include <ignition/gazebo/Export.hh>
26 #include <ignition/gazebo/Types.hh>
27 
28 #include <sdf/Element.hh>
29 
30 namespace ignition
31 {
32  namespace gazebo
33  {
34  // Inline bracket to help doxygen filtering.
35  inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
38  namespace systems {}
39 
73  class System
74  {
76  public: System() = default;
77 
79  public: virtual ~System() = default;
80  };
81 
96  public: virtual void Configure(
97  const Entity &_entity,
100  EventManager &_eventMgr) = 0;
101  };
102 
106  public: virtual void PreUpdate(const UpdateInfo &_info,
107  EntityComponentManager &_ecm) = 0;
108  };
109 
113  public: virtual void Update(const UpdateInfo &_info,
114  EntityComponentManager &_ecm) = 0;
115  };
116 
120  public: virtual void PostUpdate(const UpdateInfo &_info,
121  const EntityComponentManager &_ecm) = 0;
122  };
123  }
124  }
125 }
126 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:119
Interface for a system that uses the Update phase.
Definition: System.hh:112
Information passed to systems on the update callback.
Definition: include/ignition/gazebo/Types.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:66
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