001/* Base class for simple sink 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
027 */
028package ptolemy.actor.process.test;
029
030import ptolemy.actor.TypedCompositeActor;
031import ptolemy.actor.lib.Sink;
032import ptolemy.kernel.util.IllegalActionException;
033import ptolemy.kernel.util.NameDuplicationException;
034
035///////////////////////////////////////////////////////////////////
036//// ProcessSink
037
038/**
039 Base class for simple data sinks.  This class provides an input port,
040 exposed as a public variable, and a clone method that ensures that the
041 public variable is correctly set in the clone.  The main reason for this
042 class to ensure that the input ports of all sinks have the same name
043 and are correctly handled in cloned actors.
044
045 @author John S. Davis II
046 @version $Id$
047 @since Ptolemy II 1.0
048 @Pt.ProposedRating Green (eal)
049 @Pt.AcceptedRating Green (bilung)
050 */
051public class ProcessSink extends Sink {
052    /** Construct an actor with an input multiport.
053     *  @param container The container.
054     *  @param name The name of this actor.
055     *  @exception IllegalActionException If the entity cannot be contained
056     *   by the proposed container.
057     *  @exception NameDuplicationException If the container already has an
058     *   actor with this name.
059     */
060    public ProcessSink(TypedCompositeActor container, String name)
061            throws NameDuplicationException, IllegalActionException {
062        super(container, name);
063        _name = name;
064    }
065
066    ///////////////////////////////////////////////////////////////////
067    ////                         public methods                    ////
068
069    /**
070     */
071    @Override
072    public void fire() throws IllegalActionException {
073        super.fire();
074        /*Token token =*/input.get(0);
075
076        System.out.println(_name + ": Just finished getting a token");
077    }
078
079    /**
080     */
081    @Override
082    public boolean postfire() {
083        return false;
084    }
085
086    private String _name;
087}