ptolemy.actor

Interface TimeRegulator

All Known Implementing Classes:

SynchronizeToRealTime

public interface TimeRegulator

This interface is implemented by attributes that wish to be consulted when a director advances time. In particular, the director will call the one method in this interface, passing it a proposed time to advance to, and the method will return either the same proposed time or a smaller time. The method may not return immediately. For example, it might wait for real time to advance to the proposed time, and then simply return the proposed time.

Since:

Ptolemy II 10.0

Version:

$Id: TimeRegulator.java 66124 2013-04-23 23:09:32Z eal $

Author:

Edward A. Lee, Gilles Lasnier, Patricia Derler

Accepted Rating:

Red (cxh)

Proposed Rating:

Yellow (eal)

Method Summary

Modifier and Type	Method and Description
Time	proposeTime(Time proposedTime) Propose a time to advance to.

Method Detail

proposeTime

Time proposeTime(Time proposedTime)
          throws IllegalActionException

Propose a time to advance to.

Parameters:

proposedTime - The proposed time.

Returns:

The proposed time or a smaller time.

Throws:

IllegalActionException - If the time regulator is being misused.