Package org.goplanit.utils.network.layer

Interface MacroscopicNetworkLayer

All Superinterfaces:

Comparable<IdAble>, ExternalIdAble, IdAble, ManagedId, NetworkLayer, TopologicalLayer, UntypedDirectedGraphLayer<Node,MacroscopicLink,MacroscopicLinkSegment>, UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

All Known Implementing Classes:

MacroscopicNetworkLayerImpl

public interface MacroscopicNetworkLayer
extends UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Macroscopic physical network layer consisting of nodes, links and macroscopic link segments

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.utils.network.layer.NetworkLayer

NETWORK_LAYER_ID_CLASS

Method Summary

Modifier and Type	Method	Description
ConjugateMacroscopicNetworkLayer	createConjugate(IdGroupingToken idToken, ConjugateVirtualNetwork conjugateVirtualNetwork)	Create a conjugate version of this layer, also known as the edge-to-vertex-dual representation, where all edges become vertices and all two adjacent edges (turns) become the edges on the conjugate version.
MacroscopicNetworkLayer	deepClone()	A network layer deep clone is expected to update interdependencies between "owned" deep cloned entities where possible
default double	findMaximumPaceHKm(Mode mode)	Convenience method to determine the maximum pace (h/km) across the layer for a given mode
default double	findMaximumSpeedLimitKmH(Mode mode)	Convenience method to determine the maximum speed limit (km/h) across the layer for a given mode
MacroscopicLinks	getLinks()	Collect the links
MacroscopicLinkSegments	getLinkSegments()	Collect the link segments
MacroscopicLinkSegmentTypes	getLinkSegmentTypes()	Provide access to registered macroscopic link segment types used across all macroscopic link segments
Nodes	getNodes()	Collect the nodes
MacroscopicNetworkLayer	shallowClone()	Create a shallow copy of this entity

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

appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

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

compareTo, getId, idEquals, idHashCode

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

recreateManagedIds, resetChildManagedIdEntities

Methods inherited from interface org.goplanit.utils.network.layer.NetworkLayer

getFirstSupportedMode, getIdClass, getSupportedModes, hasSupportedModes, isEmpty, logInfo, registerSupportedMode, registerSupportedModes, reset, supports, supports, supportsPredefinedMode, validate

Methods inherited from interface org.goplanit.utils.network.layer.TopologicalLayer

createBoundingBox, transform

Methods inherited from interface org.goplanit.utils.network.layer.UntypedDirectedGraphLayer

getLayerIdGroupingToken, getLayerModifier

Methods inherited from interface org.goplanit.utils.network.layer.physical.UntypedPhysicalLayer

getNumberOfLinks, getNumberOfLinkSegments, getNumberOfNodes

Method Detail

shallowClone

MacroscopicNetworkLayer shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface NetworkLayer

Specified by:

shallowClone in interface TopologicalLayer

Specified by:

shallowClone in interface UntypedDirectedGraphLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Specified by:

shallowClone in interface UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Returns:

shallow copy of entity

deepClone

MacroscopicNetworkLayer deepClone()

A network layer deep clone is expected to update interdependencies between "owned" deep cloned entities where possible

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in interface NetworkLayer

Specified by:

deepClone in interface TopologicalLayer

Specified by:

deepClone in interface UntypedDirectedGraphLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Specified by:

deepClone in interface UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Returns:

deep copy of entity

getLinks

MacroscopicLinks getLinks()

Collect the links

Specified by:

getLinks in interface UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Returns:

the links

getLinkSegments

MacroscopicLinkSegments getLinkSegments()

Collect the link segments

Specified by:

getLinkSegments in interface UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Returns:

the linkSegments

getNodes

Nodes getNodes()

Collect the nodes

Specified by:

getNodes in interface UntypedPhysicalLayer<Node,MacroscopicLink,MacroscopicLinkSegment>

Returns:

the nodes

getLinkSegmentTypes

MacroscopicLinkSegmentTypes getLinkSegmentTypes()

Provide access to registered macroscopic link segment types used across all macroscopic link segments

Returns:

link segment types container class

findMaximumSpeedLimitKmH

default double findMaximumSpeedLimitKmH(Mode mode)

Convenience method to determine the maximum speed limit (km/h) across the layer for a given mode

Parameters:

mode - to use

Returns:

found maximum applied speed limit

findMaximumPaceHKm

default double findMaximumPaceHKm(Mode mode)

Convenience method to determine the maximum pace (h/km) across the layer for a given mode

Parameters:

mode - to use

Returns:

found maximum applied speed limit

createConjugate

ConjugateMacroscopicNetworkLayer createConjugate(IdGroupingToken idToken,
                                                 ConjugateVirtualNetwork conjugateVirtualNetwork)

Create a conjugate version of this layer, also known as the edge-to-vertex-dual representation, where all edges become vertices and all two adjacent edges (turns) become the edges on the conjugate version. When the provided id token is the same as an existing layer, vertex,edge,edge segmentids will continue numbering which might not be ideal. It is reocmmended to have a separate idToken for all conjugate layers such that all conjugate vertices, edges, edge segments are numbered uniquely within the context.

Parameters:

idToken - to use for generating ids within the layer

conjugateVirtualNetwork - to use for encountered connections to zones, when null connectoid edges/edge segments are ignored

Returns:

conjugate version of this layer