Package org.goplanit.utils.network.layer.macroscopic

Interface MacroscopicLinkFactory

All Superinterfaces:

GraphEntityFactory<MacroscopicLink>, LinkFactory<MacroscopicLink>, ManagedIdEntityFactory<MacroscopicLink>

All Known Implementing Classes:

MacroscopicLinkFactoryImpl

public interface MacroscopicLinkFactory
extends LinkFactory<MacroscopicLink>

Factory interface for creating macroscopic links (that are mode aware via their macroscopic link segments).

Author:

markr

Method Summary

Modifier and Type	Method	Description
MacroscopicLink	registerNew(Node nodeA, Node nodeB, double lengthKm, boolean registerOnNodes)	Create new macroscopic link on container, allow to be registered on nodes if indicated)

Methods inherited from interface org.goplanit.utils.id.ManagedIdEntityFactory

createUniqueDeepCopyOf, createUniqueShallowCopyOf, getIdGroupingToken, setIdGroupingToken

Method Detail

registerNew

MacroscopicLink registerNew(Node nodeA,
                            Node nodeB,
                            double lengthKm,
                            boolean registerOnNodes)

Create new macroscopic link on container, allow to be registered on nodes if indicated)

Specified by:

registerNew in interface LinkFactory<MacroscopicLink>

Parameters:

nodeA - the first node in this link

nodeB - the second node in this link

lengthKm - length of the link in km

registerOnNodes - choice to register new edge on the vertices or not

Returns:

the created link