1 package org.opentrafficsim.core.object;
2
3 import org.opentrafficsim.base.Identifyable;
4 import org.opentrafficsim.core.dsol.OTSSimulatorInterface;
5 import org.opentrafficsim.core.network.Network;
6 import org.opentrafficsim.core.network.NetworkException;
7
8 /**
9 * Interface for objects that live in a Network, but cannot be drawn and which do not have a specific location. These objects do
10 * have a name and need to be cloned when the Network is cloned. <br>
11 * Example: TrafficLightController.
12 * <p>
13 * Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
14 * BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
15 * <p>
16 * @version $Revision$, $LastChangedDate$, by $Author$, initial version Feb 10, 2017 <br>
17 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
18 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
19 * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
20 */
21 public interface InvisibleObjectInterface extends Identifyable
22 {
23
24 /**
25 * Duplicate the invisibleObject in a new simulator and network.
26 * @param newSimulator OTSSimulatorInterface; the new simulator
27 * @param newNetwork Network; the new network
28 * @return InvisibleObjectInterface; clone of this, but living in the new network and simulator
29 * @throws NetworkException when the new Network is not compatible
30 */
31 InvisibleObjectInterface clone(OTSSimulatorInterface newSimulator, Network newNetwork) throws NetworkException;
32
33 /** @return the full id that makes the id unique in the network. */
34 String getFullId();
35
36 }