Package org.planit.od.odroute

Class ODRouteMatrix

java.lang.Object

org.planit.od.ODDataImpl<Route>

org.planit.od.odroute.ODRouteMatrix

All Implemented Interfaces:

ODData<Route>

public class ODRouteMatrix
extends ODDataImpl<Route>

This class stores the route objects from each origin to each destination.

Author:

gman6028

Field Summary

Fields

Modifier and Type	Field	Description
protected long	id	Unique identifier

Fields inherited from class org.planit.od.ODDataImpl

zones

Constructor Summary

Constructors

Constructor	Description
ODRouteMatrix(IdGroupingToken groupId, Zoning.Zones zones)	Constructor

Method Summary

Modifier and Type	Method	Description
long	getId()
Route	getValue(Zone origin, Zone destination)	Returns the path for a specified origin and destination
ODRouteIterator	iterator()	Returns an iterator which can iterate through all the origin-destination cells in the matrix
void	setValue(Zone origin, Zone destination, Route path)	Set the path from a specified origin to a specified destination

Methods inherited from class org.planit.od.ODDataImpl

getNumberOfTravelAnalysisZones

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final long id

Unique identifier

Constructor Detail

ODRouteMatrix

public ODRouteMatrix(IdGroupingToken groupId,
                     Zoning.Zones zones)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

zones - the zones being used

Method Detail

getValue

public Route getValue(Zone origin,
                      Zone destination)

Returns the path for a specified origin and destination

Parameters:

origin - the specified origin zone

destination - the specified destination zone

Returns:

the path from the origin to the destination

setValue

public void setValue(Zone origin,
                     Zone destination,
                     Route path)

Set the path from a specified origin to a specified destination

Parameters:

origin - the specified origin zone

destination - the specified destination zone

path - the Path object from the origin to the destination

iterator

public ODRouteIterator iterator()

Returns an iterator which can iterate through all the origin-destination cells in the matrix

Returns:

iterator through all the origin-destination cells

getId

public long getId()

Returns:

unique identifier of this route od route matrix instance