ContainPlugin.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 
18 #ifndef GAZEBO_PLUGINS_CONTAINPLUGIN_HH_
19 #define GAZEBO_PLUGINS_CONTAINPLUGIN_HH_
20 
21 #include <memory>
22 
23 #include "gazebo/common/Plugin.hh"
24 #include "gazebo/msgs/msgs.hh"
25 
26 namespace gazebo
27 {
28  class ContainPluginPrivate;
29 
67  {
68  // Documentation inherited
69  public: ContainPlugin();
70 
71  // Documentation inherited
72  public: void Load(physics::WorldPtr _world, sdf::ElementPtr _sdf) override;
73 
76  private: void OnUpdate(const common::UpdateInfo &_info);
77 
82  private: bool Enable(const bool _enable);
83 
87  // cppcheck-suppress unusedPrivateFunction
88  private: void EnableGz(ConstIntPtr &_msg);
89 
94  // cppcheck-suppress unusedPrivateFunction
95  private: void EnableIgn(const ignition::msgs::Boolean &_req,
96  ignition::msgs::Boolean &_res, bool &_result);
97 
99  private: std::unique_ptr<ContainPluginPrivate> dataPtr;
100  };
101 }
102 
103 #endif
boost::shared_ptr< World > WorldPtr
Definition: PhysicsTypes.hh:89
Forward declarations for the common classes.
Definition: Animation.hh:33
A plugin with access to physics::World.
Definition: Plugin.hh:235
Information for use in an update event.
Definition: UpdateInfo.hh:30
Plugin which emits Ignition Transport messages according to whether an entity&#39;s origin is inside or o...
Definition: ContainPlugin.hh:66
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:58