/* Interface for transparent directors for CT sub-systems.
Copyright (c) 1999-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.domains.ct.kernel;
import ptolemy.kernel.util.IllegalActionException;
//////////////////////////////////////////////////////////////////////////
//// CTTransparentDirector
/**
Interface for CT transparent directors. This director extends the
CTGeneralDirector interface.
<p>
Transparent directors in the CT domain can transfer their internal step size
control information to the executive director. This interface 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.
<P>
Directors that implement this interface are typically contained by
CTCompositeActors.
@see CTCompositeActor
@author Jie Liu, Haiyang Zheng
@version $Id$
@since Ptolemy II 0.3
@Pt.ProposedRating Green (hyzheng)
@Pt.AcceptedRating Green (hyzheng)
*/
public interface CTTransparentDirector extends CTGeneralDirector {
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Implementations of this method should emit the current states
* of the dynamic actors executed by this director.
* @exception IllegalActionException If the data transfer is not
* completed.
*/
public void emitCurrentStates() throws IllegalActionException;
/** Implementations of this method should ask all stateful actors
* executed by this director to go to their marked states.
* If there's no marked state, throws an exception.
* @exception IllegalActionException If there is no marked state.
*/
public void goToMarkedState() throws IllegalActionException;
/** Implementations of this method should return
* true if there is an event at the current time.
* @return True if there is an event at the current time.
*/
public boolean hasCurrentEvent();
/** Implementations of this method should return
* true if all output actors declare the
* current integration step size is accurate.
* @return True if the current step size is accurate.
*/
public boolean isOutputAccurate();
/** Implementations of this method should return
* true if all stateful actors declare the
* current integration step size is accurate.
* @return True if the current step size is accurate.
*/
public boolean isStateAccurate();
/** Implementations of this method should mark the current state
* of the actors under the control of this director.
*/
public void markState();
/** Implementations of this method should return
* the predicted next step size if this step is accurate.
* @return The predicted step size.
*/
public double predictedStepSize();
/** Implementations of this method should prefire
* the dynamic actors under the control of this director.
* @return True if all dynamic actors are prefired.
* @exception IllegalActionException If the scheduler throws it, or a
* dynamic actor throws it in its prefire() method, or it can not be
* prefired.
*/
public boolean prefireDynamicActors() throws IllegalActionException;
/** Implementations of this method should return
* the refined step size if this step is not accurate.
* @return The refined step size.
*/
public double refinedStepSize();
}