org.opentrafficsim.road.gtu.lane.perception

Interface PerceptionCollectable<H extends Headway,U>

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-2017 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 and 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.

Method Summary

Modifier and Type	Method and Description
default <C,I> C	collect(PerceptionCollectable.PerceptionCollector<C,? super U,I> collector) Collect the underlying objects in to a perceived result.
<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.

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

first, isEmpty

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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; 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; the initial intermediate result value

accumulator - PerceptionAccumulator; accumulator

finalizer - PerceptionFinalizer; finalizer

Returns:

C; collection result