ptolemy.domains.ct.kernel
Interface CTTransparentDirector

All Known Implementing Classes:
CTEmbeddedDirector, HSDirector

public interface CTTransparentDirector

Interface for CT transparent directors. Transparent directors in the CT domain can transfer its internal step size control information to the executive director. It defines methods to support the step size control queries by the executive CTDirector, such that after the internal CT subsystem finishes one integration step, its step size control information will be accessible by the outside CT director.

Implementations of this interface are typically contained by CTCompositeActors.

Since:
Ptolemy II 0.3
Version:
$Id: CTTransparentDirector.java,v 1.20 2004/04/13 03:26:42 cxh Exp $
Author:
Jie Liu
See Also:
CTCompositeActor
Accepted Rating:
Yellow (chf)
Proposed Rating:
Yellow (liuj)

Method Summary
 boolean hasCurrentEvent()
          Implementations of this method should return true if there is an event at current time.
 boolean isThisStepAccurate()
          Implementations of this method should return true if the current integration step is accurate from this director's point of view.
 double predictedStepSize()
          Implementations of this method should return the predicted next step size if this step is accurate.
 double refinedStepSize()
          Implementations of this method should return the refined step size if this step is not accurate.
 

Method Detail

hasCurrentEvent

public boolean hasCurrentEvent()
Implementations of this method should return true if there is an event at current time.

Returns:
True if there is an event at current time.

isThisStepAccurate

public boolean isThisStepAccurate()
Implementations of this method should return true if the current integration step is accurate from this director's point of view.

Returns:
True if the current step is accurate.

predictedStepSize

public double predictedStepSize()
Implementations of this method should return the predicted next step size if this step is accurate.

Returns:
The predicted step size.

refinedStepSize

public double refinedStepSize()
Implementations of this method should return the refined step size if this step is not accurate.

Returns:
The refined step size.