Package org.goplanit.utils.od

Interface OdData<T>

Type Parameters:

T - the type of data to be stored for each origin-destination cell

All Superinterfaces:

Comparable<IdAble>, IdAble, Iterable<T>

All Known Subinterfaces:

OdDemands, OdHashed<T>, OdMatrix<T,U>, OdPaths

All Known Implementing Classes:

OdDataImpl, OdDemandMatrix, OdHashedImpl, OdMatrixImpl, OdNonPrimitiveMatrix, OdPathMatrix, OdPathsHashed, OdPrimitiveMatrix, OdSkimMatrix

public interface OdData<T>
extends IdAble, Iterable<T>

Interface defining methods for objects which store data related to origin and destination

Author:

gman6028

Method Summary

Modifier and Type	Method	Description
int	getNumberOfOdZones()	Returns the number of zones contained in the object
T	getValue(long originId, long destinationId)	Returns the value for a specified origin and destination by their internal id
T	getValue(Zone origin, Zone destination)	Returns the value for a specified origin and destination
OdDataIterator<T>	iterator()	Returns an iterator which can iterate through all the origin-destination cells
void	setValue(Zone origin, Zone destination, T value)	Sets the value for a specified origin and destination
OdData<T>	shallowClone()	Shallow copy

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

compareTo, deepClone, getId, idEquals, idHashCode

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getValue

T getValue(Zone origin,
           Zone destination)

Returns the value for a specified origin and destination

Parameters:

origin - specified origin

destination - specified destination

Returns:

value at the specified cell

getValue

T getValue(long originId,
           long destinationId)

Returns the value for a specified origin and destination by their internal id

Parameters:

originId - specified origin

destinationId - specified destination

Returns:

value at the specified cell

setValue

void setValue(Zone origin,
              Zone destination,
              T value)

Sets the value for a specified origin and destination

Parameters:

origin - specified origin

destination - specified destination

value - value at the specified cell

getNumberOfOdZones

int getNumberOfOdZones()

Returns the number of zones contained in the object

Returns:

number of zones in the object

iterator

OdDataIterator<T> iterator()

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

Specified by:

iterator in interface Iterable<T>

Returns:

iterator through all the origin-destination cells

shallowClone

OdData<T> shallowClone()

Shallow copy

Specified by:

shallowClone in interface IdAble

Returns:

shallow copy