org.commonreality.time

Interface IClock

All Known Subinterfaces:

INetworkedClock, IOwnableClock<T>, ISetableClock

All Known Implementing Classes:

BasicClock, MasterClock, MasterSlaveClock, NetworkedMasterClock, NetworkedSetableClock, NetworkedSlaveClock, OwnedClock, RealTimeClock, SharedClock, SlavedClock, WrappedClock

public interface IClock

central clock interface for controlling time.

Author:

developer

Method Summary

Modifier and Type	Method and Description
double	getTime()
double	getTimeShift()
void	setTimeShift(double shift) sets a constant for the clock to be adjusted by.
double	waitForChange() wait for any change of time
double	waitForTime(double time) wait for this time to be reached, returning the current time

Method Detail

getTime

double getTime()

Returns:

the current time

waitForTime

double waitForTime(double time)
            throws java.lang.InterruptedException

wait for this time to be reached, returning the current time

Parameters:

time -

Returns:

Throws:

java.lang.InterruptedException

waitForChange

double waitForChange()
              throws java.lang.InterruptedException

wait for any change of time

Throws:

java.lang.InterruptedException

setTimeShift

void setTimeShift(double shift)

sets a constant for the clock to be adjusted by. calls to waitForTime() will be shifted back by this time and calls to getTime() will be incremented by this time

Parameters:

shift -

getTimeShift

double getTimeShift()