Package org.goplanit.network.virtual

Class VirtualNetworkImpl

java.lang.Object

org.goplanit.component.PlanitComponent<Network>

org.goplanit.network.Network

org.goplanit.network.virtual.VirtualNetworkImpl

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EventListener, PlanitComponentListener, EventListener, ExternalIdAble, IdAble, VirtualNetwork

public class VirtualNetworkImpl
extends Network
implements VirtualNetwork

Model free virtual network which is part of the zoning and holds all the virtual infrastructure connecting the zones to the physical road network.

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CentroidVerticesImpl	centroidVertices	Container for centroid vertices
protected ConnectoidEdgesImpl	connectoidEdges	Container for connectoid edges
protected ConnectoidSegmentsImpl	connectoidSegments	Container for connectoid edge segments

Fields inherited from class org.goplanit.network.Network

MACROSCOPIC_NETWORK, networkIdGroupingToken

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VirtualNetworkImpl(VirtualNetworkImpl other, boolean deepCopy, GraphEntityDeepCopyMapper<ConnectoidEdge> connectoidEdgeMapper, GraphEntityDeepCopyMapper<ConnectoidSegment> connectoidSegmentMapper, GraphEntityDeepCopyMapper<CentroidVertex> centroidVertexMapper)	Copy constructor
	VirtualNetworkImpl(IdGroupingToken tokenId)	Constructor

Method Summary

Modifier and Type	Method	Description
void	clear()	free up memory by clearing contents for garbage collection
ConjugateVirtualNetworkImpl	createConjugate(IdGroupingToken idToken)	Create a conjugate version of this virtual network, also known as the edge-to-vertex-dual representation, where all connectoidedges/edge segments become (dangling) conjugate vertices.
VirtualNetworkImpl	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
VirtualNetworkImpl	deepCloneWithMapping(GraphEntityDeepCopyMapper<ConnectoidEdge> connectoidEdgeMapper, GraphEntityDeepCopyMapper<ConnectoidSegment> connectoidSegmentMapper, GraphEntityDeepCopyMapper<CentroidVertex> centroidVertexMapper)	Perform a deep clone where mappings between original and copy are captured in the two provided mappers
CentroidVertices	getCentroidVertices()	Access each centroid's vertex
ConnectoidEdges	getConnectoidEdges()	Access to connectoid edges
ConnectoidSegments	getConnectoidSegments()	Access to connectoid segments
boolean	isEmpty()	Verify if entire network is empty
void	logInfo(String prefix)	Log general information on this network to the user
void	reset()	All components should be able to reset going back to some representative initial state
VirtualNetworkImpl	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.network.Network

collectSettingsAsKeyValueMap, getNetworkGroupingTokenId

Methods inherited from class org.goplanit.component.PlanitComponent

equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, setExternalId, setXmlId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.goplanit.utils.event.EventListener

hasKnownSupportedEventTypes

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

appendExternalId, appendExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, hasExternalId, hasXmlId, setXmlId

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

compareTo, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.network.virtual.VirtualNetwork

hasConnectoidEdges, hasConnectoidSegments

Field Detail

connectoidEdges

protected final ConnectoidEdgesImpl connectoidEdges

Container for connectoid edges

connectoidSegments

protected final ConnectoidSegmentsImpl connectoidSegments

Container for connectoid edge segments

centroidVertices

protected final CentroidVerticesImpl centroidVertices

Container for centroid vertices

Constructor Detail

VirtualNetworkImpl

public VirtualNetworkImpl(IdGroupingToken tokenId)

Constructor

Parameters:

tokenId - contiguous id generation for instances of this class

VirtualNetworkImpl

protected VirtualNetworkImpl(VirtualNetworkImpl other,
                             boolean deepCopy,
                             GraphEntityDeepCopyMapper<ConnectoidEdge> connectoidEdgeMapper,
                             GraphEntityDeepCopyMapper<ConnectoidSegment> connectoidSegmentMapper,
                             GraphEntityDeepCopyMapper<CentroidVertex> centroidVertexMapper)

Copy constructor

Parameters:

other - to clone

deepCopy - when true, create a deep copy, shallow copy otherwise

connectoidEdgeMapper - to use for tracking mapping between original and copied entity (may be null)

connectoidSegmentMapper - to use for tracking mapping between original and copied entity (may be null)

centroidVertexMapper - to use for tracking mapping between original and copied entity (may be null)

Method Detail

getConnectoidSegments

public ConnectoidSegments getConnectoidSegments()

Access to connectoid segments

Specified by:

getConnectoidSegments in interface VirtualNetwork

Returns:

connectoidSegments

getConnectoidEdges

public ConnectoidEdges getConnectoidEdges()

Access to connectoid edges

Specified by:

getConnectoidEdges in interface VirtualNetwork

Returns:

connectoidEdges

getCentroidVertices

public CentroidVertices getCentroidVertices()

Access each centroid's vertex

Specified by:

getCentroidVertices in interface VirtualNetwork

Returns:

connectoidEdges

clear

public void clear()

free up memory by clearing contents for garbage collection

Specified by:

clear in interface VirtualNetwork

reset

public void reset()

All components should be able to reset going back to some representative initial state

Specified by:

reset in interface VirtualNetwork

Overrides:

reset in class Network

logInfo

public void logInfo(String prefix)

Log general information on this network to the user

Specified by:

logInfo in class Network

Parameters:

prefix - to use

isEmpty

public boolean isEmpty()

Verify if entire network is empty

Specified by:

isEmpty in interface VirtualNetwork

Specified by:

isEmpty in class Network

Returns:

true if network is empty, false otherwise

createConjugate

public ConjugateVirtualNetworkImpl createConjugate(IdGroupingToken idToken)

Create a conjugate version of this virtual network, also known as the edge-to-vertex-dual representation, where all connectoidedges/edge segments become (dangling) conjugate vertices.

It is recommended to first create the conjugate of this virtual network BEFORE creating conjugates of network layers. The latter takes a conjugate zoning as input such that it can connect the conjugate virtual nodes to the conjugate network layer where appropriate, otherwise these connections are ignored

Specified by:

createConjugate in interface VirtualNetwork

Parameters:

idToken - to use for conjugate entity creation

Returns:

conjugate version of this virtual network's edges/edgesgments

shallowClone

public VirtualNetworkImpl shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface VirtualNetwork

Specified by:

shallowClone in class Network

Returns:

shallow copy of entity

deepClone

public VirtualNetworkImpl deepClone()

deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in interface VirtualNetwork

Specified by:

deepClone in class Network

Returns:

deep copy of entity

deepCloneWithMapping

public VirtualNetworkImpl deepCloneWithMapping(GraphEntityDeepCopyMapper<ConnectoidEdge> connectoidEdgeMapper,
                                               GraphEntityDeepCopyMapper<ConnectoidSegment> connectoidSegmentMapper,
                                               GraphEntityDeepCopyMapper<CentroidVertex> centroidVertexMapper)

Perform a deep clone where mappings between original and copy are captured in the two provided mappers

Specified by:

deepCloneWithMapping in interface VirtualNetwork

Parameters:

connectoidEdgeMapper - to use for tracking mapping between original and copied entity (may be null)

connectoidSegmentMapper - to use for tracking mapping between original and copied entity (may be null)

centroidVertexMapper - to use for tracking mapping between original and copied entity (may be null)

Returns:

deep copy