001/*
002 * Copyright (c) 2009-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
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.resurgence.actor;
031
032import ptolemy.actor.TypedAtomicActor;
033import ptolemy.actor.TypedIOPort;
034import ptolemy.data.LongToken;
035import ptolemy.data.StringToken;
036import ptolemy.data.type.BaseType;
037import ptolemy.kernel.CompositeEntity;
038import ptolemy.kernel.util.IllegalActionException;
039import ptolemy.kernel.util.NameDuplicationException;
040
041///////////////////////////////////////////////////////////////
042/// StringToInt
043
044/**
045 * <p>
046 * This actor converts a string to a long.
047 * </p>
048 * <p>
049 * It is based on the Ptolemy II StringToIntArray actor.
050 * </p>
051 * 
052 * @author Chad Berkley
053 * @version $Id: StringToLong.java 24234 2010-05-06 05:21:26Z welker $
054 */
055public class StringToLong extends TypedAtomicActor {
056
057        /**
058         * Construct an actor with the given container and name.
059         * 
060         * @param container
061         *            The container.
062         * @param name
063         *            The name of this actor.
064         * @exception IllegalActionException
065         *                If the actor cannot be contained by the proposed
066         *                container.
067         * @exception NameDuplicationException
068         *                If the container already has an actor with this name.
069         */
070        public StringToLong(CompositeEntity container, String name)
071                        throws NameDuplicationException, IllegalActionException {
072                super(container, name);
073
074                string = new TypedIOPort(this, "string", true, false);
075                string.setTypeEquals(BaseType.STRING);
076
077                longport = new TypedIOPort(this, "long", false, true);
078                longport.setTypeEquals(BaseType.LONG);
079        }
080
081        // /////////////////////////////////////////////////////////////////
082        // // public variables ////
083
084        /** The input port, which has type <i>string</i>. */
085        public TypedIOPort string;
086        /** The output port, which has type <i>int</i>. */
087        public TypedIOPort longport;
088
089        // /////////////////////////////////////////////////////////////////
090        // // public methods ////
091
092        /**
093         * Consume one string token on the input port and produce a new integer
094         * token on the output port.
095         * 
096         * @exception IllegalActionException
097         *                If there is no director.
098         */
099        public void fire() throws IllegalActionException {
100                super.fire();
101                _input = ((StringToken) string.get(0)).stringValue();
102                _output = new Long(_input);
103                longport.send(0, new LongToken(_output.longValue()));
104        }
105
106        // /////////////////////////////////////////////////////////////////
107        // // protected members ////
108
109        // /////////////////////////////////////////////////////////////////
110        // // private methods ////
111
112        // /////////////////////////////////////////////////////////////////
113        // // private members ////
114
115        private String _input;
116        private Long _output;
117}