SpecializedPlugin.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2022 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_SPECIALIZEDPLUGIN_HH_
#define IGNITION_COMMON_SPECIALIZEDPLUGIN_HH_
 
#include <ignition/common/config.hh>
#include "ignition/common/Plugin.hh"
 
#include <memory>
 
namespace gz
{
  namespace common
  {
    // Forward declarations
    namespace detail { template <class, class> class ComposePlugin; }
    struct PluginInfo;
 
    // Forward declaration of the variadic template SpecializedPlugin class.
    template <class... OtherSpecInterfaces>
    class SpecializedPlugin;
 
    template <class SpecInterface>
    class SpecializedPlugin<SpecInterface> : public virtual Plugin
    {
      // -------------------- Public API ---------------------
 
      // Inherit function overloads
      public: using Plugin::QueryInterface;
      public: using Plugin::QueryInterfaceSharedPtr;
      public: using Plugin::HasInterface;
 
      // Documentation inherited
      public: template <class Interface>
              Interface *QueryInterface();
 
      // Documentation inherited
      public: template <class Interface>
              const Interface *QueryInterface() const;
 
      // Documentation inherited
      public: template <class Interface>
              std::shared_ptr<Interface> QueryInterfaceSharedPtr();
 
      // Documentation inherited
      public: template <class Interface>
              std::shared_ptr<const Interface> QueryInterfaceSharedPtr() const;
 
      // Documentation inherited
      public: template <class Interface>
              bool HasInterface() const;
 
 
      // -------------------- Private API ---------------------
 
      // Declare friendship
      template <class...> friend class SpecializedPlugin;
      template <class, class> friend class detail::ComposePlugin;
      template <class> friend class TemplatePluginPtr;
 
      private: GZ_DEPRECATED(5) SpecializedPlugin();
 
      private: template <class T> struct type { };
 
      private: template <class Interface>
               Interface *PrivateQueryInterface(type<Interface> _type);
 
      private: SpecInterface *PrivateQueryInterface(
          type<SpecInterface> _type);
 
      private: template <class Interface>
               const Interface *PrivateQueryInterface(type<Interface> _type)
               const;
 
      private: const SpecInterface *PrivateQueryInterface(
                   type<SpecInterface> _type) const;
 
      private: template <class Interface>
               bool PrivateHasInterface(type<Interface> _type) const;
 
      private: bool PrivateHasInterface(type<SpecInterface> _type) const;
 
      private: const Plugin::InterfaceMap::iterator
               privateSpecializedInterfaceIterator;
 
      // Dev note (MXG): The privateSpecializedInterfaceIterator object must be
      // available to the user during their compile time, so it cannot be hidden
      // using PIMPL. The iterator is const because it must always point to the
      // same entry throughout its entire lifecycle.
    };
  }
}
 
#include "ignition/common/detail/SpecializedPlugin.hh"
#endif  // IGNITION_COMMON_SPECIALIZEDPLUGIN_HH_