Gazebo Plugin

API Reference

1.4.0
gz/plugin/EnablePluginFromThis.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 GZ_PLUGIN_ENABLEPLUGINFROMTHIS_HH_
19#define GZ_PLUGIN_ENABLEPLUGINFROMTHIS_HH_
20
21#include <memory>
22
24
25namespace ignition
26{
27 namespace plugin
28 {
29 // Forward declaration
30 class Loader;
31
40 class IGNITION_PLUGIN_VISIBLE EnablePluginFromThis
41 {
44
48
54
56 public: virtual ~EnablePluginFromThis();
57
69
70 // Declare friendship so that the internal WeakPluginPtr can be set by
71 // the Loader class.
72 friend class Loader;
73
76 private: void PrivateSetPluginFromThis(const PluginPtr &_ptr);
77
78 private: class Implementation;
79 IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
81 IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
82 };
83 }
84}
85
86#endif
EnablePluginFromThis is an optional base class which can be inherited by Plugin classes....
Definition gz/plugin/EnablePluginFromThis.hh:41
ConstPluginPtr PluginFromThis() const
Get a const-qualified copy of the PluginPtr that manages this object.
EnablePluginFromThis()
Default constructor.
virtual ~EnablePluginFromThis()
Destructor.
PluginPtr PluginFromThis()
Get a copy of the PluginPtr that manages this object.
std::shared_ptr< void > PluginInstancePtrFromThis() const
This is an abstract shared_ptr to the Plugin instance. This shared_ptr will maintain a reference coun...
Class for loading plugins.
Definition gz/plugin/Loader.hh:39
This class manages the lifecycle of a plugin instance. It can receive a plugin instance from the igni...
Definition gz/plugin/PluginPtr.hh:53
Definition gz/plugin/EnablePluginFromThis.hh:26