WeakPluginPtr.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 IGNITION_PLUGIN_WEAKPLUGINPTR_HH_
#define IGNITION_PLUGIN_WEAKPLUGINPTR_HH_

#include <memory>

#include <ignition/plugin/PluginPtr.hh>

namespace ignition
{
  namespace plugin
  {
    class IGNITION_PLUGIN_VISIBLE WeakPluginPtr
    {
      public: WeakPluginPtr();

      public: WeakPluginPtr(const WeakPluginPtr &_other);

      public: WeakPluginPtr(WeakPluginPtr &&_other);

      // cppcheck-suppress noExplicitConstructor
      public: WeakPluginPtr(const PluginPtr &_ptr);

      public: WeakPluginPtr &operator=(const WeakPluginPtr &_other);

      public: WeakPluginPtr &operator=(WeakPluginPtr &&_other);

      public: WeakPluginPtr &operator=(const PluginPtr &_ptr);

      public: PluginPtr Lock() const;

      public: bool IsExpired() const;

      public: ~WeakPluginPtr();

      private: class Implementation;
      IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<Implementation> pimpl;
      IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}

#endif