package org.opentrafficsim.road.network;
   
   import java.util.HashMap;
   import java.util.Map;
   
   import org.opentrafficsim.core.compatibility.GTUCompatibility;
   import org.opentrafficsim.core.dsol.OTSSimulatorInterface;
   import org.opentrafficsim.core.gtu.GTUType;
   import org.opentrafficsim.core.network.Link;
  import org.opentrafficsim.core.network.LinkType;
  import org.opentrafficsim.core.network.NetworkException;
  import org.opentrafficsim.core.network.Node;
  import org.opentrafficsim.core.network.OTSLink;
  import org.opentrafficsim.core.network.OTSNode;
  import org.opentrafficsim.core.network.route.Route;
  import org.opentrafficsim.core.object.InvisibleObjectInterface;
  import org.opentrafficsim.road.network.lane.LaneType;
  
  import nl.tudelft.simulation.dsol.simulators.SimulatorInterface;
  
  /**
   * OTSRoadNetworkCloner makes a deep clone of a network. <br>
   * <br>
   * Copyright (c) 2003-2019 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
   * for project information <a href="https://www.simulation.tudelft.nl/" target="_blank">www.simulation.tudelft.nl</a>. The
   * source code and binary code of this software is proprietary information of Delft University of Technology.
   * @author <a href="https://www.tudelft.nl/averbraeck" target="_blank">Alexander Verbraeck</a>
   */
  public final class OTSRoadNetworkUtils
  {
      /** */
      private OTSRoadNetworkUtils()
      {
          // utility class
      }
  
      /**
       * Clone the OTSRoadNetwork.
       * @param network OTSRoadNetwork; the network to clone
       * @param newId String; the new id of the network
       * @param oldSimulator SimulatorInterface.TimeDoubleUnit; the old simulator for this network
       * @param newSimulator OTSSimulatorInterface; the new simulator for this network
       * @return a clone of this network
       * @throws NetworkException in case the cloning fails
       */
      @SuppressWarnings("checkstyle:designforextension")
      public static OTSRoadNetwork clone(final OTSRoadNetwork network, final String newId,
              final SimulatorInterface.TimeDoubleUnit oldSimulator, final OTSSimulatorInterface newSimulator)
              throws NetworkException
      {
          OTSRoadNetwork newNetwork = new OTSRoadNetwork(newId, false);
  
          // clone the nodes
          for (Node node : network.getNodeMap().values())
          {
              ((OTSNode) node).clone1(newNetwork, newSimulator);
          }
  
          // clone the links
          for (Link oldLink : network.getLinkMap().values())
          {
              ((OTSLink) oldLink).clone(newNetwork, newSimulator);
          }
  
          // make the link-connections for the cloned nodes
          for (Node oldNode : network.getNodeMap().values())
          {
              ((OTSNode) oldNode).clone2(newNetwork, newSimulator);
          }
  
          // clone the graphs that had been created for the old network
          for (GTUType gtuType : network.getLinkGraphs().keySet())
          {
              newNetwork.buildGraph(gtuType);
          }
  
          // clone the routes
          Map<GTUType, Map<String, Route>> newRouteMap = new HashMap<>();
          for (GTUType gtuType : network.getRouteMap().keySet())
          {
              Map<String, Route> newRoutes = new HashMap<>();
              for (Route route : network.getRouteMap().get(gtuType).values())
              {
                  newRoutes.put(route.getId(), route.clone(newNetwork, newSimulator));
              }
              newRouteMap.put(gtuType, newRoutes);
          }
          newNetwork.setRawRouteMap(newRouteMap);
  
          // clone the traffic lights
          for (InvisibleObjectInterface io : network.getInvisibleObjectMap().values())
          {
              InvisibleObjectInterface clonedIO = io.clone(newSimulator, newNetwork);
              newNetwork.addInvisibleObject(clonedIO);
          }
  
          // TODO clone the visible objects
  
          // clone the GTUTypes
         for (GTUType gtuType : network.getGtuTypes().values())
         {
             if (gtuType.getParent() == null)
             {
                 new GTUType(gtuType.getId(), newNetwork);
             }
         }
         for (GTUType gtuType : network.getGtuTypes().values())
         {
             if (gtuType.getParent() != null)
             {
                 new GTUType(gtuType.getId(), gtuType.getParent());
             }
         }
 
         // clone the LinkTypes
         for (LinkType linkType : network.getLinkTypes().values())
         {
             if (linkType.getParent() != null)
             {
                 new LinkType(linkType.getId(), linkType.getParent(), new GTUCompatibility<>(linkType.getCompatibility()),
                         newNetwork);
             }
         }
 
         // clone the LaneTypes
         for (LaneType laneType : network.getLaneTypes().values())
         {
             if (laneType.getParent() != null)
             {
                 new LaneType(laneType.getId(), laneType.getParent(), new GTUCompatibility<>(laneType.getCompatibility()),
                         newNetwork);
             }
         }
 
         return newNetwork;
     }
 
     /**
      * Remove all objects and animation in the road network.
      * @param network OTSRoadNetwork; the network to destroy
      * @param simulator SimulatorInterface.TimeDoubleUnit; the simulator of the old network
      */
     public static void destroy(final OTSRoadNetwork network, final SimulatorInterface.TimeDoubleUnit simulator)
     {
         OTSRoadNetworkUtils.destroy(network, simulator);
     }
 
 }