gov.nasa.arc.brahms.vm.api.components
Interface ITimeSyncHook

public interface ITimeSyncHook

ITimeSyncHook lets the scheduler synchronize its time advancement with external simulations. If an object implementing this interface is registered with the scheduler, then the scheduler will call its awaitTimeAdvance method after it has finished processing all events for the current time step. It will not advance to a new time until this method returns. It is possible for new events to be added to the scheduler's queue while the awaitTimeAdvance is waiting for the time-advance permission, so the time of the next event will be different after this method returns than it was before it was called.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:03:10 $ $Author: rvhoof $

Author:

David Bushnell

Method Summary

long	awaitTimeAdvance(long nextTime) Request that the external time manager allow the scheduler to advance to a new time.

Method Detail

awaitTimeAdvance

long awaitTimeAdvance(long nextTime)

Request that the external time manager allow the scheduler to advance to a new time.

Parameters:

nextTime - the time the scheduler would like to advance to.

Returns:

the time the external time manager actually allowed the scheduler to advance to.