Class StringSubstring

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

    public class StringSubstring
    extends Transformer
    Output a substring of the string provided at the input. The position of the substring within the input string is determined by the start and stop port parameters. Following Java convention, the character at start is included, but the character at stop is not. If the stop is less than start, then the substring starts at start and extends to the end of the string. The default values for start and stop are both 0; this results in an empty string at the output.
    Since:
    Ptolemy II 4.0
    Version:
    $Id$
    Author:
    Neil E. Turner and Edward A. Lee
    Pt.AcceptedRating:
    Green (net)
    Pt.ProposedRating:
    Green (net)
    • Field Detail

      • start

        public PortParameter start
        The beginning index of the input string, which is the position of first character of the desired substring. Its default value is 0, type int.
      • stop

        public PortParameter stop
        The ending index of the input string, which is 1 greater than the position of last letter of the desired substring. Its default value is 0, type int.
    • Method Detail

      • fire

        public void fire()
                  throws IllegalActionException
        If there is an input string, find a substring according to the indices given by the port parameters start and stop and produce the substring at the output. If the stop is -1 , then the substring starts at start and extends to the end of the string. In the event that the indices do not exist in the input string, throw IndexOutOfBoundsException.
        Specified by:
        fire in interface Executable
        Overrides:
        fire in class AtomicActor<TypedIOPort>
        Throws:
        IllegalActionException - If the superclass throws it, or if it is thrown reading the input port or writing to the output port.