PluginPtr.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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_COMMON_PLUGINPTR_HH_
#define IGNITION_COMMON_PLUGINPTR_HH_
 
#include <map>
#include <string>
#include <memory>
 
#include <ignition/common/config.hh>
#include "ignition/common/Plugin.hh"
 
namespace gz
{
  namespace common
  {
    // Forward declarations
    struct PluginInfo;
    namespace detail { template<class, class> class ComposePlugin; }
 
    template <typename PluginType>
    class TemplatePluginPtr final
    {
      public: ~TemplatePluginPtr() = default;
 
      public: GZ_DEPRECATED(5) TemplatePluginPtr();
 
      public: GZ_DEPRECATED(5) TemplatePluginPtr(
          const TemplatePluginPtr &_other);
 
      public: GZ_DEPRECATED(5) TemplatePluginPtr(TemplatePluginPtr &&_other);
 
      public: template <typename OtherPluginType>
              GZ_DEPRECATED(5) TemplatePluginPtr(
                  const TemplatePluginPtr<OtherPluginType> &_other);
 
      public: TemplatePluginPtr &operator =(const TemplatePluginPtr &_other);
 
      public: template <typename OtherPluginType>
              TemplatePluginPtr &operator =(
                  const TemplatePluginPtr<OtherPluginType> &_other);
 
      public: TemplatePluginPtr &operator =(TemplatePluginPtr &&_other);
 
      public: TemplatePluginPtr &operator =(std::nullptr_t);
 
      public: PluginType *operator ->() const;
 
      public: PluginType &operator *() const;
 
      public: bool operator ==(const TemplatePluginPtr &_other) const;
 
      public: bool operator <(const TemplatePluginPtr &_other) const;
 
      public: bool operator >(const TemplatePluginPtr &_other) const;
 
      public: bool operator !=(const TemplatePluginPtr &_other) const;
 
      public: bool operator <=(const TemplatePluginPtr &_other) const;
 
      public: bool operator >=(const TemplatePluginPtr &_other) const;
 
      public: std::size_t Hash() const;
 
      public: bool IsEmpty() const;
 
      public: operator bool() const;
 
      public: void Clear();
 
      private: explicit GZ_DEPRECATED(5) TemplatePluginPtr(
          const PluginInfo *_info);
 
      private: std::unique_ptr<PluginType> dataPtr;
 
      // Declare friendship
      friend class PluginLoader;
      template <class> friend class TemplatePluginPtr;
    };
 
    using PluginPtr = TemplatePluginPtr<Plugin>;
 
    using ConstPluginPtr = TemplatePluginPtr<const Plugin>;
  }
}
 
#include "ignition/common/detail/PluginPtr.hh"
 
#endif