gz/plugin/EnablePluginFromThis.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GZ_PLUGIN_ENABLEPLUGINFROMTHIS_HH_
#define GZ_PLUGIN_ENABLEPLUGINFROMTHIS_HH_
 
#include <memory>
 
#include <gz/plugin/PluginPtr.hh>
 
namespace ignition
{
  namespace plugin
  {
    // Forward declaration
    class Loader;
 
    class IGNITION_PLUGIN_VISIBLE EnablePluginFromThis
    {
      public: EnablePluginFromThis();
 
      public: PluginPtr PluginFromThis();
 
      public: ConstPluginPtr PluginFromThis() const;
 
      public: virtual ~EnablePluginFromThis();
 
      protected: std::shared_ptr<void> PluginInstancePtrFromThis() const;
 
      // Declare friendship so that the internal WeakPluginPtr can be set by
      // the Loader class.
      friend class Loader;
 
      private: void PrivateSetPluginFromThis(const PluginPtr &_ptr);
 
      private: class Implementation;
      IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<Implementation> pimpl;
      IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
 
#endif