plugin.h

#ifndef f3d_plugin_h
#define f3d_plugin_h

#include "reader.h"

#include <memory>
#include <string>
#include <vector>

namespace f3d
{
/**
 * @class   plugin
 * @brief   The base class of plugins
 *
 * Plugins implementation are automatically generated with CMake macros.
 * This is the base class of every plugin.
 *
 * See ``f3d_plugin_init``, ``f3d_plugin_declare_reader``, and ``f3d_plugin_build`` in
 * the ``f3dPlugin.cmake`` module.
 *
 * @warning This file is used internally by the plugin SDK, it should not be included
 * directly by libf3d users.
 */
class plugin
{
public:
  plugin(const std::string& name, const std::string& desc, const std::string& vers,
    const std::vector<std::shared_ptr<reader>>& readers)
    : Name(name)
    , Description(desc)
    , Version(vers)
    , Readers(readers)
  {
  }

  /**
   * Get the name of this plugin
   */
  const std::string& getName() const
  {
    return this->Name;
  }

  /**
   * Get the description of this plugin
   */
  const std::string& getDescription() const
  {
    return this->Description;
  }

  /**
   * Get the version of this plugin
   */
  const std::string& getVersion() const
  {
    return this->Version;
  }

  /**
   * Get the list of readers created by this plugin
   */
  const std::vector<std::shared_ptr<reader>>& getReaders() const
  {
    return this->Readers;
  }

  ///@{
  /**
   * Set/Get the origin of this plugin, usually static, system or an actual path
   * Set by the engine.
   */
  const std::string& getOrigin() const
  {
    return this->Origin;
  }
  void setOrigin(const std::string& origin)
  {
    this->Origin = origin;
  }
  ///@}

private:
  std::string Name;
  std::string Description;
  std::string Version;
  std::vector<std::shared_ptr<reader>> Readers;
  std::string Origin = "undefined";
};

}

#endif