Gazebo Gazebo

API Reference

6.16.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 <gz/sim/System.hh>
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 namespace systems
32 {
33  // Forward declaration
34  class OpticalTactilePluginPrivate;
35 
88 
90  public System,
91  public ISystemConfigure,
92  public ISystemPreUpdate,
93  public ISystemPostUpdate
94  {
96  public: OpticalTactilePlugin();
97 
99  public: ~OpticalTactilePlugin() override = default;
100 
101  // Documentation inherited
102  public: void Configure(const Entity &_entity,
105  EventManager &_eventMgr) override;
106 
108  public: void PreUpdate(const UpdateInfo &_info,
109  EntityComponentManager &_ecm) override;
110 
111  // Documentation inherited
112  public: void PostUpdate(
113  const ignition::gazebo::UpdateInfo &_info,
114  const ignition::gazebo::EntityComponentManager &_ecm) override;
115 
118  };
119 } // namespace systems
120 } // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
121 } // namespace gazebo
122 } // namespace ignition
123 
124 #endif
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light....
Definition: gz/sim/Entity.hh:58
This library is part of the Gazebo project.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:66
STL class.
Plugin that implements an optical tactile sensor.
Definition: OpticalTactilePlugin.hh:89
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:54
void PostUpdate(const ignition::gazebo::UpdateInfo &_info, const ignition::gazebo::EntityComponentManager &_ecm) override
~OpticalTactilePlugin() override=default
Destructor.
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:38
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:121
Interface for a system that uses the PostUpdate phase.
Definition: gz/sim/System.hh:135
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:90
Base class for a System.
Definition: gz/sim/System.hh:75
void Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
Configure the system.
void PreUpdate(const UpdateInfo &_info, EntityComponentManager &_ecm) override
Documentation inherited.