001/* An interface for directors that have tentative and committed state.
002
003 Copyright (c) 2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.actor.continuous;
029
030//////////////////////////////////////////////////////////////////////////
031//// ContinuousStatefulDirector
032
033/**
034 Interface for directors
035 that have a getCurrentStepSize() method and have state that can be
036 rolled back.
037 @author  Christopher Brooks
038 @version $Id$
039 @since Ptolemy II 10.0
040 @Pt.ProposedRating Green (hyzheng)
041 @Pt.AcceptedRating Green (eal)
042 */
043public interface ContinuousStatefulDirector
044        extends ContinuousStatefulComponent {
045    /** Return the current integration step size.
046     *  @return The current integration step size.
047     */
048    public double getCurrentStepSize();
049
050    /** Return the local truncation error tolerance.
051     *  @return The local truncation error tolerance.
052     */
053    public double getErrorTolerance();
054}