Package org.planit.network.virtual

Class VirtualNetwork.ConnectoidSegments

java.lang.Object

org.planit.network.virtual.VirtualNetwork.ConnectoidSegments

All Implemented Interfaces:

Iterable<ConnectoidSegment>

Enclosing class:

VirtualNetwork

public class VirtualNetwork.ConnectoidSegments
extends Object
implements Iterable<ConnectoidSegment>

Internal class for non-physical LinkSegment specific code, i.e. connectoid segments (physical link segments are placed in the network)

Constructor Summary

Constructors

Constructor	Description
ConnectoidSegments()

Method Summary

Modifier and Type	Method	Description
ConnectoidSegment	createAndRegisterConnectoidSegment(Connectoid parentConnectoid, boolean directionAB)	Create and register connectoid segment in AB direction on virtual network
ConnectoidSegment	getConnectoidSegment(long id)	Get connectoid segment by id
int	getNumberOfConnectoidSegments()	Return the number of registered connectoid segments
Iterator<ConnectoidSegment>	iterator()	Iterator for all connectoid segments available
protected ConnectoidSegment	registerConnectoidSegment(ConnectoidSegment connectoidSegment)	Register a connectid segment on the zoning

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ConnectoidSegments

public ConnectoidSegments()

Method Detail

registerConnectoidSegment

protected ConnectoidSegment registerConnectoidSegment(ConnectoidSegment connectoidSegment)

Register a connectid segment on the zoning

Parameters:

connectoidSegment - ConnectoidSegment to be registered

Returns:

the registered connectoid segment

iterator

public Iterator<ConnectoidSegment> iterator()

Iterator for all connectoid segments available

Specified by:

iterator in interface Iterable<ConnectoidSegment>

createAndRegisterConnectoidSegment

public ConnectoidSegment createAndRegisterConnectoidSegment(Connectoid parentConnectoid,
                                                            boolean directionAB)
                                                     throws PlanItException

Create and register connectoid segment in AB direction on virtual network

Parameters:

parentConnectoid - the connectoid which will contain this connectoid segment

directionAB - direction of travel

Returns:

created connectoid segment

Throws:

PlanItException - thrown if there is an error

getConnectoidSegment

public ConnectoidSegment getConnectoidSegment(long id)

Get connectoid segment by id

Parameters:

id - the id of this connectoid segment

Returns:

retrieved ConnectoidSegment object

getNumberOfConnectoidSegments

public int getNumberOfConnectoidSegments()

Return the number of registered connectoid segments

Returns:

the number of registered connectoid segments