Package org.planit.utils.zoning

Interface Connectoids

All Superinterfaces:

Iterable<Connectoid>

All Known Implementing Classes:

ConnectoidsImpl

public interface Connectoids
extends Iterable<Connectoid>

container to register and manager connectoids that define the points of access for zones regarding infrastructure network (layer)

Author:

markr

Method Summary

Modifier and Type	Method	Description
Connectoid	get(long id)	Get connectoid by id
Connectoid	register(Connectoid connectoid)	register a connectoid If new connectoid overrides an existing connectoid, the removed connectoid is returned
DirectedConnectoid	registerNew(LinkSegment accessLinkSegment)	Create new connectoid for a physical access node and leave the connections for access zones for later
DirectedConnectoid	registerNew(LinkSegment accessLinkSegment, Zone parentZone)	Create new connectoid for a zone and physical access edge segment
DirectedConnectoid	registerNew(LinkSegment accessLinkSegment, Zone accessZone, double length)	Create new connectoid for a zone and physical access node
UndirectedConnectoid	registerNew(Node accessNode)	Create new connectoid for a physical access node and leave the connections for access zones for later
UndirectedConnectoid	registerNew(Node accessNode, Zone parentZone)	Create new connectoid for a zone and physical access node
UndirectedConnectoid	registerNew(Node accessNode, Zone accessZone, double length)	Create new connectoid for a zone and physical access node
int	size()	Return number of connectoids

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

register

Connectoid register(Connectoid connectoid)

register a connectoid If new connectoid overrides an existing connectoid, the removed connectoid is returned

Parameters:

connectoid - the connectoid to be registered

Returns:

connectoid added

registerNew

UndirectedConnectoid registerNew(Node accessNode,
                                 Zone accessZone,
                                 double length)
                          throws PlanItException

Create new connectoid for a zone and physical access node

Parameters:

accessNode - node providing access to network layer

accessZone - of the connectoid

length - length of connectoid

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

registerNew

UndirectedConnectoid registerNew(Node accessNode,
                                 Zone parentZone)
                          throws PlanItException

Create new connectoid for a zone and physical access node

Parameters:

accessNode - node providing access to network layer

parentZone - of the connectoid

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

registerNew

UndirectedConnectoid registerNew(Node accessNode)
                          throws PlanItException

Create new connectoid for a physical access node and leave the connections for access zones for later

Parameters:

accessNode - node providing access to network layer

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

registerNew

DirectedConnectoid registerNew(LinkSegment accessLinkSegment,
                               Zone accessZone,
                               double length)
                        throws PlanItException

Create new connectoid for a zone and physical access node

Parameters:

accessLinkSegment - link segment providing access to network layer

accessZone - of the connectoid

length - length of connectoid

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

registerNew

DirectedConnectoid registerNew(LinkSegment accessLinkSegment,
                               Zone parentZone)
                        throws PlanItException

Create new connectoid for a zone and physical access edge segment

Parameters:

accessLinkSegment - link segment providing access to network layer

parentZone - of the connectoid

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

registerNew

DirectedConnectoid registerNew(LinkSegment accessLinkSegment)
                        throws PlanItException

Create new connectoid for a physical access node and leave the connections for access zones for later

Parameters:

accessLinkSegment - link segment providing access to network layer

Returns:

registered connectoid

Throws:

PlanItException - thrown if error

get

Connectoid get(long id)

Get connectoid by id

Parameters:

id - the id of this connectoid

Returns:

the retrieved connectoid

size

int size()

Return number of connectoids

Returns:

the number of connectoids