Ignition Gazebo

API Reference

6.0.0~pre1
OpticalTactilePlugin.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 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 
18 #ifndef IGNITION_GAZEBO_SYSTEMS_OPTICAL_TACTILE_PLUGIN_HH_
19 #define IGNITION_GAZEBO_SYSTEMS_OPTICAL_TACTILE_PLUGIN_HH_
20 
21 #include <memory>
23 #include "Visualization.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 {
32 namespace systems
33 {
34  // Forward declaration
35  class OpticalTactilePluginPrivate;
36 
89 
91  public System,
92  public ISystemConfigure,
93  public ISystemPreUpdate,
94  public ISystemPostUpdate
95  {
97  public: OpticalTactilePlugin();
98 
100  public: ~OpticalTactilePlugin() override = default;
101 
102  // Documentation inherited
103  public: void Configure(const Entity &_entity,
106  EventManager &_eventMgr) override;
107 
109  public: void PreUpdate(const UpdateInfo &_info,
110  EntityComponentManager &_ecm) override;
111 
112  // Documentation inherited
113  public: void PostUpdate(
114  const ignition::gazebo::UpdateInfo &_info,
115  const ignition::gazebo::EntityComponentManager &_ecm) override;
116 
119  };
120 } // namespace systems
121 } // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
122 } // namespace gazebo
123 } // namespace ignition
124 
125 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:119
Plugin that implements an optical tactile sensor.
Definition: OpticalTactilePlugin.hh:90
void Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
Configure the system.
Information passed to systems on the update callback.
Definition: 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
void PreUpdate(const UpdateInfo &_info, EntityComponentManager &_ecm) override
Documentation inherited.
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
void PostUpdate(const UpdateInfo &_info, const EntityComponentManager &_ecm) override
Interface for a system that uses the PreUpdate phase.
Definition: System.hh:105
Base class for a System.
Definition: System.hh:73