org.opentrafficsim.draw.graphs.AbstractSamplerPlot Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ots-draw Show documentation
OTS drawing classes that can paint themselves using data objects
The newest version!
package org.opentrafficsim.draw.graphs;

import java.util.ArrayList;
import java.util.List;

import org.djunits.value.vdouble.scalar.Duration;
import org.djunits.value.vdouble.scalar.Length;
import org.djunits.value.vdouble.scalar.Time;
import org.opentrafficsim.draw.graphs.GraphPath.Section;
import org.opentrafficsim.kpi.interfaces.LaneData;
import org.opentrafficsim.kpi.sampling.SamplerData;
import org.opentrafficsim.kpi.sampling.TrajectoryGroup;

/**
 * Super class for plots that use sampler data. Sub classes may obtain trajectories using {@code getTrajectories()}, or
 * alternatively maintain some other -possibly more efficient- connection to the sampler. This class also connects the plot to a
 * path, consisting of a list of lanes. Start distance along the path for each lane is provided to sub classes using
 * {@code getStartDistance(LaneData)}. Total length is obtained using {@code getEndLocation()}.
 * 
 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. 

 * BSD-style license. See OpenTrafficSim License.
 * 
 * @author Alexander Verbraeck
 * @author Peter Knoppers
 * @author Wouter Schakel
 */
public abstract class AbstractSamplerPlot extends AbstractSpaceTimePlot
{

    /** Sampler data. */
    private final SamplerData samplerData;

    /** KPI lane directions registered in the sampler. */
    private final GraphPath> path;

    /** Time when trajectories were last updated per series in the path. */
    private List lastUpdateTime = new ArrayList<>();

    /** Cached trajectories per series in the path. */
    private List>> trajectoriesCache = new ArrayList<>();

    /**
     * Constructor.
     * @param caption String; caption
     * @param updateInterval Duration; regular update interval (simulation time)
     * @param scheduler PlotScheduler; scheduler.
     * @param samplerData SamplerData<?>; sampler data
     * @param path GraphPath<? extends LaneData>; path
     * @param delay Duration; amount of time that chart runs behind simulation to prevent gaps in the charted data
     */
    public AbstractSamplerPlot(final String caption, final Duration updateInterval, final PlotScheduler scheduler,
            final SamplerData samplerData, final GraphPath> path, final Duration delay)
    {
        super(caption, updateInterval, scheduler, delay, DEFAULT_INITIAL_UPPER_TIME_BOUND);
        this.samplerData = samplerData;
        this.path = path;
        for (int i = 0; i < path.getNumberOfSeries(); i++)
        {
            this.trajectoriesCache.add(new ArrayList<>());
            this.lastUpdateTime.add(null);
        }
    }

    /**
     * Returns all trajectories for the series, in order of the path.
     * @param series int; series number
     * @return List<TrajectoryGroup>; the trajectories
     */
    protected List> getTrajectories(final int series)
    {
        if (this.lastUpdateTime.get(series) == null || this.lastUpdateTime.get(series).lt(getUpdateTime()))
        {
            List> cache = new ArrayList<>();
            for (Section> section : getPath().getSections())
            {
                cache.add(this.samplerData.getTrajectoryGroup(section.getSource(series)));
            }
            this.trajectoriesCache.set(series, cache);
            this.lastUpdateTime.set(series, getUpdateTime());
        }
        return this.trajectoriesCache.get(series);
    }

    /**
     * Returns the path.
     * @return GraphPath<? extends LaneData>; the path
     */
    public final GraphPath> getPath()
    {
        return this.path;
    }

    /** {@inheritDoc} */
    @Override
    protected final Length getEndLocation()
    {
        return getPath().getTotalLength();
    }

    /**
     * Returns the sampler data.
     * @return SamplerData<?>; sampler.
     */
    protected final SamplerData getSamplerData()
    {
        return this.samplerData;
    }

}