001/* A base class for DE domain actors.
002
003 Copyright (c) 1998-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.domains.de.kernel;
028
029import ptolemy.actor.TimedActor;
030import ptolemy.actor.TypedAtomicActor;
031import ptolemy.actor.lib.SequenceActor;
032import ptolemy.kernel.CompositeEntity;
033import ptolemy.kernel.util.IllegalActionException;
034import ptolemy.kernel.util.NameDuplicationException;
035
036//////////////////////////////////////////////////////////////////////////
037//// DEActor
038
039/**
040 The base class for actors specific to the DE domain. This class
041 implements both SequenceActor and TimedActor.
042 <p>
043 A DE domain-specific actor, like the
044 {@link ptolemy.domains.de.lib.TimedDelay} actor, needs to extend this
045 class. However, it does not mean only actors extending this class can
046 be used in the DE domain. For example, the {@link ptolemy.actor.lib.Clock}
047 actor can be used in DE domain.
048
049 @author Jie Liu, Haiyang Zheng
050 @version $Id$
051 @since Ptolemy II 0.2
052 @Pt.ProposedRating Green (hyzheng)
053 @Pt.AcceptedRating Green (hyzheng)
054 */
055public abstract class DEActor extends TypedAtomicActor
056        implements SequenceActor, TimedActor {
057    /** Construct an actor with the specified container and name.
058     *  This is protected because there is no reason to create an instance
059     *  of this class, but derived classes will want to invoke the
060     *  constructor of the superclass.
061     *  @param container The container.
062     *  @param name The name.
063     *  @exception IllegalActionException If the entity cannot be contained
064     *   by the proposed container.
065     *  @exception NameDuplicationException If the container already has an
066     *   actor with this name.
067     */
068    protected DEActor(CompositeEntity container, String name)
069            throws NameDuplicationException, IllegalActionException {
070        super(container, name);
071    }
072}