Package org.opentrafficsim.draw.graphs

Class GraphCrossSection<S>

java.lang.Object

org.opentrafficsim.draw.graphs.AbstractGraphSpace<S>

org.opentrafficsim.draw.graphs.GraphCrossSection<S>

Type Parameters:

S - underlying type of path sections

All Implemented Interfaces:

Iterable<S>

public class GraphCrossSection<S>
extends AbstractGraphSpace<S>

A GraphCrossSection defines the location of graphs. It has one section having one or more source objects depending on the number of series. For example, a 3-lane road may result in a section with 3 series. Graphs can aggregate the series, or show multiple series.

Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor	Description
GraphCrossSection(String seriesName, GraphPath.Section<S> section, Length position)	Constructor for a one-series cross section.
GraphCrossSection(List<String> seriesNames, GraphPath.Section<S> section, List<Length> positions)	Constructor.

Method Summary

Modifier and Type	Method	Description
S	getSource(int series)	Returns the underlying source of the series.
Iterator<S>	iterator()
Iterator<S>	iterator(int series)	Returns an iterator over the sources on the given series.
Length	position(int series)	Returns the position on the underlying source of the series.
String	toString()

Methods inherited from class org.opentrafficsim.draw.graphs.AbstractGraphSpace

getName, getNumberOfSeries

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

GraphCrossSection

public GraphCrossSection(String seriesName,
 GraphPath.Section<S> section,
 Length position)

Constructor for a one-series cross section.

Parameters:

seriesName - String; name of series

section - Section<S>; section

position - Length; position on the section

GraphCrossSection

public GraphCrossSection(List<String> seriesNames,
 GraphPath.Section<S> section,
 List<Length> positions)

Constructor.

Parameters:

seriesNames - List<String>; names of series

section - Section<S>; section

positions - List<Length>; position on the section

Method Details

getSource

public S getSource(int series)

Returns the underlying source of the series.

Parameters:

series - int; series number

Returns:

S; underlying source of the series

iterator

public Iterator<S> iterator(int series)

Returns an iterator over the sources on the given series.

Specified by:

iterator in class AbstractGraphSpace<S>

Parameters:

series - int; number of the series

Returns:

Iterator<S>; iterator over the sources on the given series

position

public Length position(int series)

Returns the position on the underlying source of the series.

Parameters:

series - int; series number

Returns:

Length; position on the underlying source of the series

iterator

public Iterator<S> iterator()

toString

public String toString()

Overrides:

toString in class Object