PerceptionCollectable (OpenTrafficSim road classes 1.6.0 API)

Type Parameters:

H - headway type

U - underlying object type

All Superinterfaces:

Iterable<H>, PerceptionIterable<H>

All Known Implementing Classes:

AbstractPerceptionIterable, AbstractPerceptionReiterable, DownstreamNeighborsIterable, LaneBasedObjectIterable, MultiLanePerceptionIterable, SortedSetPerceptionIterable, UpstreamNeighborsIterable
```
public interface PerceptionCollectable<H extends Headway,U>
extends PerceptionIterable<H>
```
Iterable that additionally provides support for PerceptionCollectors. These gather raw data, to only 'perceive' the result.
Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 1 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`PerceptionCollectable.Intermediate<I>`	Wrapper of intermediate result with info for the iterator algorithm.
`static interface`	`PerceptionCollectable.PerceptionAccumulator<U,I>`	Accumulates an object one at a time in to an accumulating intermediate result.
`static interface`	`PerceptionCollectable.PerceptionCollector<C,U,I>`	Combination of an accumulator and a finalizer.
`static interface`	`PerceptionCollectable.PerceptionFinalizer<C,I>`	Translates the last intermediate result of an accumulator in to the collection output.
`static class`	`PerceptionCollectable.UnderlyingDistance<U>`	Wrapper for object and its distance.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`<C,I> C`	`collect(Supplier<I> identity, PerceptionCollectable.PerceptionAccumulator<? super U,I> accumulator, PerceptionCollectable.PerceptionFinalizer<C,I> finalizer)`	Collect the underlying objects in to a perceived result.
`default <C,I> C`	`collect(PerceptionCollectable.PerceptionCollector<C,? super U,I> collector)`	Collect the underlying objects in to a perceived result.
`Iterator<U>`	`underlying()`	Returns an iterator over the underlying objects.
`Iterator<PerceptionCollectable.UnderlyingDistance<U>>`	`underlyingWithDistance()`	Returns an iterator over the underlying objects coupled with the distance.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface org.opentrafficsim.road.gtu.lane.perception.PerceptionIterable
first, isEmpty

- Method Detail
  - collect
```
default <C,I> C collect(PerceptionCollectable.PerceptionCollector<C,? super U,I> collector)
```
    Collect the underlying objects in to a perceived result. This methodology is loosely based on Stream.collect().
    
    Type Parameters:
    
    C - collection result type
    
    I - intermediate type
    
    Parameters:
    
    collector - PerceptionCollector<C, ? super U, I>; collector
    
    Returns:
    
    C; collection result
  - collect
```
<C,I> C collect(Supplier<I> identity,
                      PerceptionCollectable.PerceptionAccumulator<? super U,I> accumulator,
                      PerceptionCollectable.PerceptionFinalizer<C,I> finalizer)
```
    Collect the underlying objects in to a perceived result. This methodology is loosely based on Stream.collect().
    
    Type Parameters:
    
    C - collection result type
    
    I - intermediate type
    
    Parameters:
    
    identity - Supplier<I>; the initial intermediate result value
    
    accumulator - PerceptionAccumulator<? super U, I>; accumulator
    
    finalizer - PerceptionFinalizer<C, I>; finalizer
    
    Returns:
    
    C; collection result
  - underlying
```
Iterator<U> underlying()
```
    Returns an iterator over the underlying objects.
    
    Returns:
    
    Iterator<U>; iterator
  - underlyingWithDistance
```
Iterator<PerceptionCollectable.UnderlyingDistance<U>> underlyingWithDistance()
```
    Returns an iterator over the underlying objects coupled with the distance.
    
    Returns:
    
    Iterator<UnderlyingDistance<U>>; iterator