DevDessAnimator.java
package nl.tudelft.simulation.dsol.simulators;
import java.io.Serializable;
import nl.tudelft.simulation.dsol.SimRuntimeException;
import nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEventInterface;
import nl.tudelft.simulation.dsol.simtime.SimTime;
/**
* The reference implementation of the animator.
* <p>
* Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
* for project information <a href="https://simulation.tudelft.nl/" target="_blank"> https://simulation.tudelft.nl</a>. The DSOL
* project is distributed under a three-clause BSD-style license, which can be found at
* <a href="https://https://simulation.tudelft.nl/dsol/docs/latest/license.html" target="_blank">
* https://https://simulation.tudelft.nl/dsol/docs/latest/license.html</a>.
* </p>
* @author <a href="https://www.linkedin.com/in/peterhmjacobs">Peter Jacobs </a>
* @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @param <T> the time type
* @since 1.5
*/
public class DevDessAnimator<T extends Number & Comparable<T>> extends DevDessSimulator<T> implements AnimatorInterface
{
/** */
private static final long serialVersionUID = 20140804L;
/**
* @param initialTimeStep T; the initial time step to use in the integration.
* @param id the id of the simulator, used in logging and firing of events.
* @throws SimRuntimeException when initialTimeStep <= 0, NaN, or Infinity
*/
public DevDessAnimator(final Serializable id, final T initialTimeStep) throws SimRuntimeException
{
super(id, initialTimeStep);
}
/** AnimationDelay refers to the delay in milliseconds between timeSteps. */
@SuppressWarnings("checkstyle:visibilitymodifier")
protected long animationDelay = 100L;
/** {@inheritDoc} */
@Override
public long getAnimationDelay()
{
return this.animationDelay;
}
/** {@inheritDoc} */
@Override
public void setAnimationDelay(final long animationDelay)
{
this.animationDelay = animationDelay;
this.fireEvent(ANIMATION_DELAY_CHANGED_EVENT, animationDelay);
}
/** {@inheritDoc} */
@Override
public void updateAnimation()
{
this.fireTimedEvent(AnimatorInterface.UPDATE_ANIMATION_EVENT, null, this.simulatorTime);
}
/** {@inheritDoc} */
@Override
public void run()
{
AnimationThread animationThread = new AnimationThread(this);
animationThread.start();
// set the run flag semaphore to signal to startImpl() that the run method has started
this.runflag = true;
while (!isStoppingOrStopped() && !this.eventList.isEmpty()
&& this.simulatorTime.compareTo(this.replication.getEndTime()) <= 0)
{
try
{
if (this.animationDelay > 0)
{
Thread.sleep(this.animationDelay);
}
}
catch (Exception exception)
{
exception = null;
// Let's neglect this sleep..
}
T runUntil = SimTime.plus(this.simulatorTime, this.timeStep);
while (!this.eventList.isEmpty() && !isStoppingOrStopped()
&& runUntil.compareTo(this.eventList.first().getAbsoluteExecutionTime()) >= 0)
{
synchronized (super.semaphore)
{
int cmp = this.eventList.first().getAbsoluteExecutionTime().compareTo(this.runUntilTime);
if ((cmp == 0 && !this.runUntilIncluding) || cmp > 0)
{
this.simulatorTime = SimTime.copy(this.runUntilTime);
this.runState = RunState.STOPPING;
break;
}
SimEventInterface<T> event = this.eventList.removeFirst();
if (event.getAbsoluteExecutionTime().compareTo(super.simulatorTime) != 0)
{
super.fireUnverifiedTimedEvent(SimulatorInterface.TIME_CHANGED_EVENT, null,
event.getAbsoluteExecutionTime());
}
this.simulatorTime = event.getAbsoluteExecutionTime();
try
{
event.execute();
if (this.eventList.isEmpty())
{
this.simulatorTime = SimTime.copy(this.runUntilTime);
this.runState = RunState.STOPPING;
break;
}
}
catch (Exception exception)
{
handleSimulationException(exception);
}
}
}
if (!isStoppingOrStopped())
{
this.simulatorTime = runUntil;
}
this.fireTimedEvent(SimulatorInterface.TIME_CHANGED_EVENT, null, this.simulatorTime);
}
updateAnimation();
animationThread.stopAnimation();
}
}