ptolemy.actor

Interface TimeRegulator

All Known Implementing Classes:

HlaManager, 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$

Author:

Edward A. Lee, Gilles Lasnier, Patricia Derler

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (eal)

Method Summary

Modifier and Type	Method and Description
boolean	noNewActors() Return false if change requests have been posted while during the call to proposeTime.
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.

noNewActors

boolean noNewActors()

Return false if change requests have been posted while during the call to proposeTime.

Returns:

false is ChangeRequest has been queued for a new actor