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

Interface MacroscopicLinkSegmentFactory

All Superinterfaces:

GraphEntityFactory<MacroscopicLinkSegment>, ManagedIdEntityFactory<MacroscopicLinkSegment>

All Known Implementing Classes:

MacroscopicLinkSegmentFactoryImpl

public interface MacroscopicLinkSegmentFactory
extends GraphEntityFactory<MacroscopicLinkSegment>

Factory to create link segments and register them on its container

Author:

markr

Method Summary

Modifier and Type	Method	Description
MacroscopicLinkSegment	create(MacroscopicLink parentLink, boolean directionAB)	Create macroscopic link segment, do not register nor register on nodes and link
Pair<MacroscopicLinkSegment,MacroscopicLinkSegment>	registerNew(MacroscopicLink parentLink, boolean registerOnLink)	Create macroscopic link segments in both directions and register them
MacroscopicLinkSegment	registerNew(MacroscopicLink parentLink, boolean directionAb, boolean registerOnLink)	Create a macroscopic link segment and register it
MacroscopicLinkSegment	registerNew(MacroscopicLink parentLink, MacroscopicLinkSegmentType type, boolean directionAb, boolean registerOnLink)	Create a macroscopic link segment and register it

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

createUniqueDeepCopyOf, createUniqueShallowCopyOf, getIdGroupingToken, setIdGroupingToken

Method Detail

create

MacroscopicLinkSegment create(MacroscopicLink parentLink,
                              boolean directionAB)
                       throws PlanItException

Create macroscopic link segment, do not register nor register on nodes and link

Parameters:

parentLink - the parent of this segment

directionAB - direction of travel

Returns:

the created segment

Throws:

PlanItException - thrown if error

registerNew

Pair<MacroscopicLinkSegment,MacroscopicLinkSegment> registerNew(MacroscopicLink parentLink,
                                                                      boolean registerOnLink)

Create macroscopic link segments in both directions and register them

Parameters:

parentLink - the parent of this segment

registerOnLink - option to register the new segment on the underlying link

Returns:

the created segments as a pair with direction (Ab,Ba)

registerNew

MacroscopicLinkSegment registerNew(MacroscopicLink parentLink,
                                   boolean directionAb,
                                   boolean registerOnLink)

Create a macroscopic link segment and register it

Parameters:

parentLink - the parent of this segment

directionAb - direction of travel

registerOnLink - option to register the new segment on the underlying link

Returns:

the created segment

registerNew

MacroscopicLinkSegment registerNew(MacroscopicLink parentLink,
                                   MacroscopicLinkSegmentType type,
                                   boolean directionAb,
                                   boolean registerOnLink)

Create a macroscopic link segment and register it

Parameters:

parentLink - the parent of this segment

type - the type of the link segment

directionAb - direction of travel

registerOnLink - option to register the new segment on the underlying link

Returns:

the created segment