Ignition Gazebo

API Reference

4.1.0
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>
22 #include <ignition/gazebo/Export.hh>
24 #include "Visualization.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 {
33 namespace systems
34 {
35  // Forward declaration
36  class OpticalTactilePluginPrivate;
37 
68 
69  class IGNITION_GAZEBO_VISIBLE OpticalTactilePlugin :
70  public System,
71  public ISystemConfigure,
72  public ISystemPreUpdate,
73  public ISystemPostUpdate
74  {
76  public: OpticalTactilePlugin();
77 
79  public: ~OpticalTactilePlugin() override = default;
80 
81  // Documentation inherited
82  public: void Configure(const Entity &_entity,
85  EventManager &_eventMgr) override;
86 
88  public: void PreUpdate(const UpdateInfo &_info,
89  EntityComponentManager &_ecm) override;
90 
91  // Documentation inherited
92  public: void PostUpdate(
93  const ignition::gazebo::UpdateInfo &_info,
94  const ignition::gazebo::EntityComponentManager &_ecm) override;
95 
98  };
99 }
100 }
101 }
102 }
103 
104 #endif
Interface for a system that uses the PostUpdate phase.
Definition: System.hh:108
Plugin that implements an optical tactile sensor.
Definition: OpticalTactilePlugin.hh:69
Information passed to systems on the update callback.
Definition: Types.hh:36
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:77
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:94
Base class for a System.
Definition: System.hh:62