nl.tudelft.simulation.dsol.simulators
Interface AnimatorInterface

All Superinterfaces:
DESSSimulatorInterface, DEVDESSSimulatorInterface, DEVSSimulatorInterface, EventProducerInterface, Remote, Serializable, SimulatorInterface
All Known Implementing Classes:
Animator, AnimatorWithThread, RealTimeClock

public interface AnimatorInterface
extends DEVDESSSimulatorInterface

The AnimatorInterface defines a DEVSDESS simulator with wallclock delay between the consequtive time steps.

(c) copyright 2002-2005 Delft University of Technology , the Netherlands.
See for project information www.simulation.tudelft.nl
License of use: Lesser General Public License (LGPL) , no warranty.

Since:
1.0
Version:
$Revision: 1.1 $ $Date: 2007/01/06 13:21:27 $
Author:
Peter Jacobs

Field Summary
static EventType ANIMATION_DELAY_CHANGED_EVENT
          ANIMATION_DELAY_CHANGED_EVENT is fired when the time step is set
static long DEFAULT_ANIMATION_DELAY
          DEFAULT_ANIMATION_DELAY of 0 miliseconds used in the animator
static EventType UPDATE_ANIMATION_EVENT
          UPDATE_ANIMATION_EVENT is fired to wake up animatable components
 
Fields inherited from interface nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface
EVENTLIST_CHANGED_EVENT
 
Fields inherited from interface nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface
DEFAULT_TIME_STEP, TIME_STEP_CHANGED_EVENT
 
Fields inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface
END_OF_REPLICATION_EVENT, START_EVENT, START_REPLICATION_EVENT, STEP_EVENT, STOP_EVENT, TIME_CHANGED_EVENT, WARMUP_EVENT
 
Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface
FIRST_POSITION, LAST_POSITION
 
Method Summary
 long getAnimationDelay()
          returns the animation delay between each consequtive timestep
 void setAnimationDelay(long miliseconds)
          sets the animationDelay
 
Methods inherited from interface nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface
cancelEvent, getEventList, scheduleEvent, scheduleEvent, scheduleEvent, scheduleEvent, scheduleEvent, setEventList
 
Methods inherited from interface nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface
getTimeStep, setTimeStep
 
Methods inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface
getReplication, getSimulatorTime, initialize, isRunning, start, step, stop
 
Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface
addListener, addListener, addListener, addListener, getEventTypes, removeListener
 

Field Detail

DEFAULT_ANIMATION_DELAY

static final long DEFAULT_ANIMATION_DELAY
DEFAULT_ANIMATION_DELAY of 0 miliseconds used in the animator

See Also:
Constant Field Values

UPDATE_ANIMATION_EVENT

static final EventType UPDATE_ANIMATION_EVENT
UPDATE_ANIMATION_EVENT is fired to wake up animatable components


ANIMATION_DELAY_CHANGED_EVENT

static final EventType ANIMATION_DELAY_CHANGED_EVENT
ANIMATION_DELAY_CHANGED_EVENT is fired when the time step is set

Method Detail

getAnimationDelay

long getAnimationDelay()
                       throws RemoteException
returns the animation delay between each consequtive timestep

Returns:
the animaiton delay in milliseconds wallclock
Throws:
RemoteException - on network failure

setAnimationDelay

void setAnimationDelay(long miliseconds)
                       throws RemoteException
sets the animationDelay

Parameters:
miliseconds - the animation delay
Throws:
RemoteException - on network failure


Copyright © 2002-2010 Delft University of Technology, the Netherlands. All Rights Reserved.