OtsPlotScheduler.java

package org.opentrafficsim.swing.graphs;

import java.util.LinkedHashMap;
import java.util.Map;

import org.djunits.value.vdouble.scalar.Duration;
import org.opentrafficsim.animation.graphs.AbstractPlot;
import org.opentrafficsim.animation.graphs.PlotScheduler;
import org.opentrafficsim.core.dsol.OtsSimulatorInterface;

import nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEventInterface;

/**
 * This scheduler allows plots to work live with an OTS simulation.
 * <p>
 * Copyright (c) 2023-2026 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
 * </p>
 * @author Wouter Schakel
 */
public class OtsPlotScheduler implements PlotScheduler
{

    /** Simulator. */
    private final OtsSimulatorInterface simulator;

    /** Latest update event per plot. */
    private final Map<AbstractPlot<?>, SimEventInterface<Duration>> events = new LinkedHashMap<>();

    /** Whether a last event was scheduled given replication time. */
    private boolean scheduledLastEvent = false;

    /**
     * Constructor.
     * @param simulator simulator.
     */
    public OtsPlotScheduler(final OtsSimulatorInterface simulator)
    {
        this.simulator = simulator;
    }

    @Override
    public Duration getTime()
    {
        return this.simulator.getSimulatorTime();
    }

    @Override
    public void cancelEvent(final AbstractPlot<?> abstractPlot)
    {
        SimEventInterface<Duration> event = this.events.get(abstractPlot);
        if (event != null)
        {
            this.simulator.cancelEvent(event);
        }
        this.scheduledLastEvent = false;
    }

    @Override
    public void scheduleUpdate(final Duration time, final AbstractPlot<?> abstractPlot)
    {
        if (this.scheduledLastEvent)
        {
            return;
        }
        cancelEvent(abstractPlot);
        // in case the time is beyond the replication time, schedule one last event at the replication time
        this.scheduledLastEvent = time.si > this.simulator.getReplication().getEndTime().si;
        Duration t = this.scheduledLastEvent ? this.simulator.getReplication().getEndTime() : time;
        this.events.put(abstractPlot, this.simulator.scheduleEventAbs(t, () -> abstractPlot.update()));
    }

    @Override
    public void scheduleUpdateNow(final AbstractPlot<?> abstractPlot)
    {
        if (this.scheduledLastEvent)
        {
            return;
        }
        cancelEvent(abstractPlot);
        this.events.put(abstractPlot, this.simulator.scheduleEventNow(() -> abstractPlot.update()));
    }

}