001/* Base class for directors for component domains.
002
003 Copyright (c) 1997-2014 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 */
027package ptolemy.component;
028
029import ptolemy.kernel.util.IllegalActionException;
030
031///////////////////////////////////////////////////////////////////
032//// ComponentDirector
033
034/**
035 FIXME
036
037 @author Yang Zhao and Edward A. Lee
038 @version $Id$
039 @since Ptolemy II 11.0
040 @Pt.ProposedRating yellow (ellen_zh)
041 @Pt.AcceptedRating red (davisj)
042 */
043public class ComponentDirector implements Component {
044    ///////////////////////////////////////////////////////////////////
045    ////                         public methods                    ////
046
047    /** Initialize the component.  This is invoked once after
048     *  preinitialize() and again whenever the component needs
049     *  to be reinitialized.
050     *  @exception IllegalActionException If initialization
051     *   cannot be completed.
052     */
053    @Override
054    public void initialize() throws IllegalActionException {
055        // FIXME
056    }
057
058    /** Preinitialize the component. This is invoked exactly
059     *  once per execution of a model, before any other methods
060     *  in this interface are invoked.
061     *  @exception IllegalActionException If preinitialization
062     *   cannot be completed.
063     */
064    @Override
065    public void preinitialize() throws IllegalActionException {
066        // FIXME
067    }
068
069    /** Execute the component. This is invoked after preinitialize()
070     *  and initialize(), and may be invoked repeatedly.
071     * @exception IllegalActionException If the run cannot be completed.
072     */
073    @Override
074    public void run() throws IllegalActionException {
075        // FIXME
076    }
077
078    /** Wrap up an execution. This method is invoked exactly once
079     *  per execution of a model. It finalizes an execution, typically
080     *  closing files, displaying final results, etc. If any other
081     *  method from this interface is invoked after this, it must
082     *  begin with preinitialize().
083     *  @exception IllegalActionException If wrapup fails.
084     */
085    @Override
086    public void wrapup() throws IllegalActionException {
087        // FIXME
088    }
089}