001/* This actor converts a string to a date.
002
003 Copyright (c) 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.lib.conversions;
029
030import ptolemy.data.DateToken;
031import ptolemy.data.StringToken;
032import ptolemy.data.type.BaseType;
033import ptolemy.kernel.CompositeEntity;
034import ptolemy.kernel.util.IllegalActionException;
035import ptolemy.kernel.util.NameDuplicationException;
036
037///////////////////////////////////////////////////////////////////
038/// StringToDouble
039
040/**
041 Convert a string to a double.
042
043 <p>This actor converts a string to a date.</p>
044
045 @author Patricia Derler
046 @version $Id$
047 @since Ptolemy II 10.0
048 @Pt.ProposedRating Red (pd)
049 @Pt.AcceptedRating Red (pd)
050 */
051public class StringToDate extends Converter {
052    /** Construct an actor with the given container and name.
053     *  @param container The container.
054     *  @param name The name of this actor.
055     *  @exception IllegalActionException If the actor 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 StringToDate(CompositeEntity container, String name)
061            throws NameDuplicationException, IllegalActionException {
062        super(container, name);
063
064        input.setTypeEquals(BaseType.STRING);
065
066        output.setTypeEquals(BaseType.DATE);
067    }
068
069    ///////////////////////////////////////////////////////////////////
070    ////                         public methods                    ////
071
072    /** Consume one StringToken on the input port and output a new
073     * Datetoken.
074     *
075     *  @exception IllegalActionException If thrown while getting
076     *  or sending a token.
077     */
078    @Override
079    public void fire() throws IllegalActionException {
080        super.fire();
081        String inputValue = ((StringToken) input.get(0)).stringValue();
082        output.send(0, new DateToken(inputValue));
083    }
084
085    /** Return false if the input port has no token, otherwise return
086     *  what the superclass returns (presumably true).
087     *  @exception IllegalActionException If there is no director.
088     */
089    @Override
090    public boolean prefire() throws IllegalActionException {
091        if (!input.hasToken(0)) {
092            return false;
093        }
094
095        return super.prefire();
096    }
097}