/* Output the length of a string provided at the input.
Copyright (c) 2003-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.actor.lib.string;
import ptolemy.actor.lib.Transformer;
import ptolemy.data.IntToken;
import ptolemy.data.StringToken;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
//////////////////////////////////////////////////////////////////////////
//// StringLength
/**
Output the length of a string provided at the input.
@author Edward A. Lee
@version $Id: StringLength.java,v 1.12 2005/07/08 19:56:37 cxh Exp $
@since Ptolemy II 4.0
@Pt.ProposedRating Green (eal)
@Pt.AcceptedRating Green (net)
*/
public class StringLength extends Transformer {
/** Construct an actor with the given container and name.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the actor cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* actor with this name.
*/
public StringLength(CompositeEntity container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
// Set the types of the ports.
input.setTypeEquals(BaseType.STRING);
output.setTypeEquals(BaseType.INT);
}
///////////////////////////////////////////////////////////////////
//// public methods ////
/** If there is an input string, find its length and produce the
* length at the output. If there is no input, do nothing.
* @exception IllegalActionException If the superclass throws it, or
* if it is thrown reading the input port or writing to the
* output port.
*/
public void fire() throws IllegalActionException {
super.fire();
if (input.hasToken(0)) {
StringToken inputToken = (StringToken) input.get(0);
String value = inputToken.stringValue();
int length = value.length();
output.send(0, new IntToken(length));
}
}
}