Package ptolemy.actor.gt

Class TransformationMode

    • Constructor Detail

      • TransformationMode

        public TransformationMode​(NamedObj container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException
        Construct a parameter with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This parameter will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. The object is not added to the list of objects in the workspace unless the container is null. Increment the version of the workspace.
        Parameters:
        container - The container.
        name - The name of the parameter.
        Throws:
        IllegalActionException - If the parameter is not of an acceptable class for the container.
        NameDuplicationException - If the name coincides with a parameter already in the container.

    • Method Detail

      • clone

        public java.lang.Object clone​(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
        Clone the variable. This creates a new variable containing the same token (if the value was set with setToken()) or the same (unevaluated) expression, if the expression was set with setExpression(). The list of variables added to the scope is not cloned; i.e., the clone has an empty scope. The clone has the same static type constraints (those given by setTypeEquals() and setTypeAtMost()), but none of the dynamic type constraints (those relative to other variables).
        Overrides:
        clone in class Parameter
        Parameters:
        workspace - The workspace in which to place the cloned variable.
        Returns:
        The cloned variable.
        Throws:
        java.lang.CloneNotSupportedException - Not thrown in this base class.
        See Also:
        Object.clone()

      • findAllMatches

        public java.util.List<MatchResult> findAllMatches​(TransformationRule workingCopy,
                                                  CompositeEntity model)
        Find all the matches to the pattern in the workingCopy and return those matches in a list. When invoked a second time, the previously returned list would be invalidated. It is the caller's responsibility to duplicate the list if it needs to be preserved after the next invocation.
        Parameters:
        workingCopy - The transformation rule that can be modified.
        model - The model for pattern matching.
        Returns:
        The list of matches.

      • foundMatch

        public boolean foundMatch​(GraphMatcher matcher)
        A routine to be called when a match is found in the graph matching. The graph matcher is passed in as the parameter, and the current match can be obtained by calling GraphMatcher.getMatchResult(). This match result should not be kept, however, because it may be changed by future matching operations. To keep a copy of this result, invoke MatchResult.clone() and keep the cloned copy. The return value indicates whether the match is the one looked for. If it is true, the matching will terminate after this routine returns, and no more match result will be reported.
        Specified by:
        foundMatch in interface MatchCallback
        Parameters:
        matcher - The graph matcher.
        Returns:
        Whether the matching should terminate right away.

      • getWorkingCopy

        public TransformationRule getWorkingCopy​(TransformationRule masterRule)
                                  throws IllegalActionException
        Get a working copy for the transformation rule, which can be modified in pattern matching and transformation without affecting the original rule.
        Parameters:
        masterRule - The transformation rule.
        Returns:
        The working copy.
        Throws:
        IllegalActionException - If a working copy cannot be obtained.

      • isMatchOnly

        public boolean isMatchOnly()
        Whether the transformation mode is match only.
        Returns:
        true if the transformation mode is match only.

      • transform

        public boolean transform​(TransformationRule workingCopy,
                         CompositeEntity model,
                         TransformationListener listener,
                         boolean defer)
                  throws IllegalActionException
        Transform the model with the working copy.
        Parameters:
        workingCopy - The working copy.
        model - The model to be transformed.
        listener - The listener to be invoked during transformation.
        defer - Whether the change should be deferred if necessary with a change request.
        Returns:
        true if the transformation was successful (i.e., any match to the pattern is found).
        Throws:
        IllegalActionException - If thrown in pattern matching or transformation.