interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2018-2024 by the authors of the World Builder code.

  This file is part of the World Builder.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
   by the Free Software Foundation, either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef WORLD_BUILDER_COORDINATE_SYSTEMS_INTERFACE_H
#define WORLD_BUILDER_COORDINATE_SYSTEMS_INTERFACE_H

#include "world_builder/coordinate_systems/interface.h"

#include "world_builder/coordinate_system.h"
#include "world_builder/parameters.h"
#include "world_builder/types/string.h"


namespace WorldBuilder
{
  class World;

  namespace CoordinateSystems
  {

    class ObjectFactory;

    class Interface
    {
      public:
        Interface();

        virtual
        ~Interface();

        static
        void declare_entries(Parameters &prm,
                             const std::string &parent_name,
                             const std::vector<std::string> &required_entries);

        virtual
        void parse_entries(Parameters &prm) = 0;

        virtual
        CoordinateSystem natural_coordinate_system() const = 0;

        virtual
        DepthMethod depth_method() const = 0;

        virtual
        std::array<double,3> cartesian_to_natural_coordinates(const std::array<double,3> &position) const = 0;

        virtual
        std::array<double,3> natural_to_cartesian_coordinates(const std::array<double,3> &position) const = 0;

        virtual
        double distance_between_points_at_same_depth(const Point<3> &point_1, const Point<3> &point_2) const = 0;

        virtual
        double max_model_depth() const = 0;

        static void registerType(const std::string &name,
                                 void ( * /*declare_entries*/)(Parameters &, const std::string &),
                                 ObjectFactory *factory);

        static std::unique_ptr<Interface> create(const std::string &name, WorldBuilder::World *world);

      protected:
        WorldBuilder::World *world;



      private:
        static std::map<std::string, ObjectFactory *> &get_factory_map()
        {
          static std::map<std::string, ObjectFactory *> factories;
          return factories;
        }

        static std::map<std::string, void ( *)(Parameters &,const std::string &)> &get_declare_map()
        {
          static std::map<std::string, void ( *)(Parameters &,const std::string &)> declares;
          return declares;
        }
    };



    class ObjectFactory
    {
      public:
        virtual std::unique_ptr<Interface> create(World *world) = 0;
    };

#define WB_REGISTER_COORDINATE_SYSTEM(classname,name) \
  class classname##Factory : public ObjectFactory { \
    public: \
      classname##Factory() \
      { \
        Interface::registerType(#name, classname::declare_entries, this); \
      } \
      std::unique_ptr<Interface> create(World *world) override final { \
        return std::unique_ptr<Interface>(new classname(world)); \
      } \
  }; \
  static classname##Factory global_##classname##Factory;

  } // namespace CoordinateSystems
} // namespace WorldBuilder

#endif