Class PortCreationOperation


  • public class PortCreationOperation
    extends Operation
    An operation to create a port.
    Since:
    Ptolemy II 8.0
    Version:
    $Id$
    Author:
    Thomas Huining Feng
    Pt.AcceptedRating:
    Red (tfeng)
    Pt.ProposedRating:
    Yellow (tfeng)
    • Constructor Detail

      • PortCreationOperation

        public PortCreationOperation​(GTIngredientList owner)
        Construct an operation within the given list as its owner. All elements are enabled and are initialized to empty at the beginning.
        Parameters:
        owner - The list as the owner of the constructed GTIngredientList.
      • PortCreationOperation

        public PortCreationOperation​(GTIngredientList owner,
                                     java.lang.String values)
        Construct an operation within the given list as its owner and initialize all the elements with the given values, which are a string encoding of those elements. All elements are enabled at the beginning.
        Parameters:
        owner - The list as the owner of the constructed GTIngredientList.
        values - The string encoding of the values of the elements.
      • PortCreationOperation

        public PortCreationOperation​(GTIngredientList owner,
                                     java.lang.String portName,
                                     java.lang.String portClass,
                                     java.lang.String portType,
                                     boolean input,
                                     boolean output,
                                     boolean multiport,
                                     boolean autoRename)
        Construct an operation within the given list as its owner and with the given value to each of its elements..
        Parameters:
        owner - The list as the owner of the constructed GTIngredientList.
        portName - Value of the portName element.
        portClass - Value of the portClass element.
        portType - Value of the portType element.
        input - Value of the input element.
        output - Value of the output element.
        multiport - Value of the multiport element.
        autoRename - Value of the autoRename element.
    • Method Detail

      • getChangeRequest

        public ChangeRequest getChangeRequest​(Pattern pattern,
                                              Replacement replacement,
                                              MatchResult matchResult,
                                              NamedObj patternObject,
                                              NamedObj replacementObject,
                                              NamedObj hostObject)
                                       throws IllegalActionException
        Get the change request to update the object in the host model.
        Specified by:
        getChangeRequest in class Operation
        Parameters:
        pattern - The pattern of the transformation rule.
        replacement - The replacement of the transformation rule.
        matchResult - The match result.
        patternObject - The object in the pattern, or null.
        replacementObject - The object in the replacement that corresponds to the object in the pattern.
        hostObject - The object in the host model corresponding to the object in the replacement.
        Returns:
        The change request.
        Throws:
        IllegalActionException - If error occurs in generating the change request.
      • getValue

        public java.lang.Object getValue​(int index)
        Get the value of the index-th elements.
        Specified by:
        getValue in class GTIngredient
        Parameters:
        index - The index.
        Returns:
        The value.
        See Also:
        setValue(int, Object)
      • getValues

        public java.lang.String getValues()
        Get a string that describes the values of all the elements.
        Specified by:
        getValues in class GTIngredient
        Returns:
        A string that describes the values of all the elements.
        See Also:
        setValues(String)
      • isApplicable

        public boolean isApplicable​(NamedObj object)
        Check whether this GTIngredient is applicable to the object.
        Overrides:
        isApplicable in class GTIngredient
        Parameters:
        object - The object.
        Returns:
        true if this GTIngredient is applicable; false otherwise.
      • isPortClassEnabled

        public boolean isPortClassEnabled()
        Return whether the portClass element is enabled.
        Returns:
        true if the portClass element is enabled.
      • isPortTypeEnabled

        public boolean isPortTypeEnabled()
        Return whether the portType element is enabled.
        Returns:
        true if the portType element is enabled.
      • setValue

        public void setValue​(int index,
                             java.lang.Object value)
        Set the value of the index-th element.
        Specified by:
        setValue in class GTIngredient
        Parameters:
        index - The index.
        value - The value.
        See Also:
        getValue(int)
      • setValues

        public void setValues​(java.lang.String values)
        Set the values of all the elements with a string that describes them.
        Specified by:
        setValues in class GTIngredient
        Parameters:
        values - A string that describes the new values of all the elements.
        See Also:
        getValues()