interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2018 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 <boost/property_tree/ptree.hpp>

#include <world_builder/utilities.h>
#include <world_builder/coordinate_system.h>


using boost::property_tree::ptree;

namespace WorldBuilder
{
  namespace CoordinateSystems
  {

    class Interface
    {
      public:
        Interface();

        virtual
        ~Interface();

        virtual
        void decare_entries(std::string &path) = 0;

        virtual
        CoordinateSystem natural_coordinate_system() 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;

      protected:

    };


    std::unique_ptr<Interface>
    create_coordinate_system(const std::string name);

  }
}

#endif