Uses of Interface org.goplanit.utils.od.OdDataIterator (planit-all 0.3.0 API)

Packages that use OdDataIterator
Package	Description
org.goplanit.od.demand	Contains the definitions of the Origin-Destination Demand classes
org.goplanit.od.path	This package holds the origin-destination path objects.
org.goplanit.od.skim	This package holds the origin-destination Skim Matrix objects.
org.goplanit.output.adapter	Output Adapter and Output Type Adapter classes and interfaces
org.goplanit.utils.od	Top-level abstract interfaces to handle Origin-Destination Data

Uses of OdDataIterator in org.goplanit.od.demand

Classes in org.goplanit.od.demand that implement OdDataIterator
Modifier and Type Class Description

class OdDemandMatrix.OdDemandMatrixIterator
Wrapper around primitive matrix iterator

Uses of OdDataIterator in org.goplanit.od.path

Subinterfaces of OdDataIterator in org.goplanit.od.path
Modifier and Type	Interface	Description
`interface`	`OdPathIterator`	Iterator for directed paths tracked by od

Classes in org.goplanit.od.path that implement OdDataIterator
Modifier and Type	Class	Description
`class`	`OdPathMatrix.OdPathMatrixIterator`	Wrapper around primitive matrix iterator
`class`	`OdPathsHashed.OdPathsHashedIterator`	Wrapper around hashed iterator for od paths

Uses of OdDataIterator in org.goplanit.od.skim

Classes in org.goplanit.od.skim that implement OdDataIterator
Modifier and Type Class Description

class OdSkimMatrix.OdSkimMatrixIterator
Wrapper around primitive matrix iterator

Uses of OdDataIterator in org.goplanit.output.adapter

Methods in org.goplanit.output.adapter with parameters of type OdDataIterator
Modifier and Type	Method	Description
`static Optional<String>`	OdOutputTypeAdapter.`getDestinationZoneExternalId(OdDataIterator<?> odIterator)`	Returns the external Id of the destination zone for the current OD
`static Optional<String>`	PathOutputTypeAdapter.`getDestinationZoneExternalId(OdDataIterator<?> odPathIterator)`	Returns the external Id of the destination zone for the current cell in the OD path matrix
`static Optional<Long>`	OdOutputTypeAdapter.`getDestinationZoneId(OdDataIterator<?> odIterator)`	Returns the Id of the destination zone for the current cell in the OD destination
`static Optional<Long>`	PathOutputTypeAdapter.`getDestinationZoneId(OdDataIterator<?> odPathIterator)`	Returns the Id of the destination zone for the current cell in the OD path matrix
`static Optional<String>`	OdOutputTypeAdapter.`getDestinationZoneXmlId(OdDataIterator<?> odIterator)`	Returns the XML Id of the destination zone for the current OD destination
`static Optional<String>`	PathOutputTypeAdapter.`getDestinationZoneXmlId(OdDataIterator<?> odPathIterator)`	Returns the Xml Id of the destination zone for the current cell in the OD path matrix
`Optional<?>`	OdOutputTypeAdapter.`getOdOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<?> odIterator, Mode mode, TimePeriod timePeriod)`	Returns the specified output property values for the current cell in the OD Matrix Iterator
`Optional<?>`	OdOutputTypeAdapterImpl.`getOdOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<?> odIterator, Mode mode, TimePeriod timePeriod)`	Returns the specified output property values for the current cell in the OD Matrix Iterator
`static <T> Optional<T>`	OdOutputTypeAdapter.`getOdValue(OdDataIterator<T> odIterator)`	Returns the Od value
`static Optional<String>`	OdOutputTypeAdapter.`getOriginZoneExternalId(OdDataIterator<?> odIterator)`	Returns the origin zone external Id for the current cell in the OD origin
`static Optional<String>`	PathOutputTypeAdapter.`getOriginZoneExternalId(OdDataIterator<?> odPathIterator)`	Returns the origin zone external Id for the current cell in the OD path matrix
`static Optional<Long>`	OdOutputTypeAdapter.`getOriginZoneId(OdDataIterator<?> odIterator)`	Returns the origin zone Id for the current cell in the OD origin
`static Optional<Long>`	PathOutputTypeAdapter.`getOriginZoneId(OdDataIterator<?> odPathIterator)`	Returns the origin zone Id for the current cell in the OD path matrix
`static Optional<String>`	OdOutputTypeAdapter.`getOriginZoneXmlId(OdDataIterator<?> odIterator)`	Returns the origin zone XML Id for the current cell in the OD origin
`static Optional<String>`	PathOutputTypeAdapter.`getOriginZoneXmlId(OdDataIterator<?> odPathIterator)`	Returns the Xml Id of the origin zone for the current cell in the OD path matrix
`static Optional<String>`	PathOutputTypeAdapter.`getPathAsString(OdDataIterator<? extends DirectedPath> odPathIterator, PathOutputIdentificationType pathOutputType)`	Returns the path as a String of comma-separated Id values
`static Optional<Long>`	PathOutputTypeAdapter.`getPathId(OdDataIterator<? extends DirectedPath> odPathIterator)`	Return the Id of the current path If there is no path between the current origin and destination zones, this returns -1
`Optional<?>`	PathOutputTypeAdapter.`getPathOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<? extends DirectedPath> odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)`	Returns the specified output property values for the current cell in the ODPathIterator
`Optional<?>`	PathOutputTypeAdapterImpl.`getPathOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<? extends DirectedPath> odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)`	Returns the specified output property values for the current cell in the ODPathIterator

Uses of OdDataIterator in org.goplanit.utils.od

Classes in org.goplanit.utils.od that implement OdDataIterator
Modifier and Type	Class	Description
`class`	`OdHashedIterator<T>`	Base Hash key oriented Iterator which runs through available ods that have non-zero values
`class`	`OdMatrixIterator<T,U>`	BAse matrix oriented Iterator which runs through rows and columns of some matrix type of container, making the value, row and column of each cell available
`class`	`OdNonPrimitiveMatrixIterator<T>`	Iterator of OdMatrix with objects stored as raw two dimensional array
`class`	`OdPrimitiveMatrixIterator<T extends Number>`	Iterator of OdMatrix with primitives stored as Array2D

Methods in org.goplanit.utils.od that return OdDataIterator
Modifier and Type	Method	Description
`OdDataIterator<T>`	OdData.`iterator()`	Returns an iterator which can iterate through all the origin-destination cells