001/*
002 * Copyright (c) 2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-12-07 23:35:50 +0000 (Tue, 07 Dec 2010) $' 
007 * '$Revision: 26427 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.geon;
031
032//tokens
033import ptolemy.actor.TypedAtomicActor;
034import ptolemy.actor.TypedIOPort;
035import ptolemy.data.type.BaseType;
036import ptolemy.kernel.CompositeEntity;
037import ptolemy.kernel.util.IllegalActionException;
038import ptolemy.kernel.util.NameDuplicationException;
039
040/**
041 * A template actor used in Gravity modeling design workflow.
042 * 
043 * @UserLevelDocumentation A template actor used in Gravity modeling design
044 *                         workflow.
045 * @author Efrat Jaeger
046 * @version $Id: GridOverlay.java 26427 2010-12-07 23:35:50Z welker $
047 */
048public class GridOverlay extends TypedAtomicActor {
049        public GridOverlay(CompositeEntity container, String name)
050                        throws NameDuplicationException, IllegalActionException {
051                super(container, name);
052                input = new TypedIOPort(this, "input", true, false);
053                input.setTypeEquals(BaseType.DOUBLE_MATRIX); // Push or Pull
054                input.setMultiport(true);
055                output = new TypedIOPort(this, "output", false, true);
056                output.setTypeEquals(BaseType.DOUBLE_MATRIX);
057
058        }
059
060        public TypedIOPort input;
061        public TypedIOPort output;
062
063        public void initialize() throws IllegalActionException {
064        }
065
066        public boolean prefire() throws IllegalActionException {
067                return super.prefire();
068        }
069
070        public void fire() throws IllegalActionException {
071                super.fire();
072        }
073}