Package ptolemy.actor.lib.hoc

Class RefinementPort

  • All Implemented Interfaces:
    java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class RefinementPort
extends TypedIOPort
    A port for controllers and refinements in modal models. This port mirrors certain changes to it in the ports of the container of the container. That container in turn mirrors those changes in other refinements and/or controllers. This class is designed to work closely with ModalPort, since changes to the ports can be initiated from either class.
    Since:
    Ptolemy II 5.2
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (liuxj)
    Pt.ProposedRating:
    Red (eal)

    • Field Detail

      • _automaticallyInput

        protected boolean _automaticallyInput
        Indicator that the port is automatically an input port because it was set to be an output port. This automatic change is made in output ports of the ModalController so that if a refinement writes to its output port, then that data is available in scope for the guard expressions.

      • _mirrorDisable

        protected boolean _mirrorDisable
        If false, then changes the port are mirrored in the container's container. This is false by default.

    • Constructor Detail

      • RefinementPort

        public RefinementPort​(Workspace workspace)
               throws IllegalActionException
        Construct a port in the given workspace.
        Parameters:
        workspace - The workspace.
        Throws:
        IllegalActionException - If the port is not of an acceptable class for the container, or if the container does not implement the TypedActor interface.

      • RefinementPort

        public RefinementPort​(ComponentEntity container,
                      java.lang.String name)
               throws IllegalActionException,
                      NameDuplicationException
        Construct a port with a containing actor and a name that is neither an input nor an output. The specified container must implement the TypedActor interface, or an exception will be thrown.
        Parameters:
        container - The container actor.
        name - The name of the port.
        Throws:
        IllegalActionException - If the port is not of an acceptable class for the container, or if the container does not implement the TypedActor interface.
        NameDuplicationException - If the name coincides with a port already in the container.

    • Method Detail

      • isTypeAcceptable

        public boolean isTypeAcceptable()
        Override the super class method to allow UNKNOWN type if this port does not have any inside links.
        Specified by:
        isTypeAcceptable in interface Typeable
        Overrides:
        isTypeAcceptable in class TypedIOPort
        Returns:
        True if this port does not have any inside links, or the super class method returns true.

      • link

        public void link​(Relation relation)
          throws IllegalActionException
        Set the connected relation to a bus if this port is a multiport.
        Overrides:
        link in class IOPort
        Parameters:
        relation - The relation to link to.
        Throws:
        IllegalActionException - If the link crosses levels of the hierarchy, or the port has no container, or the relation is not an instance of IORelation.

      • moveDown

        public int moveDown()
             throws IllegalActionException
        Move this object down by one in the list of attributes of its container. If this object is already last, do nothing. This method overrides the base class to mirror the change in any mirror ports. Increment the version of the workspace.
        Specified by:
        moveDown in interface Moveable
        Overrides:
        moveDown in class Port
        Returns:
        The index of the specified object prior to moving it, or -1 if it is not moved.
        Throws:
        IllegalActionException - If this object has no container.

      • moveToFirst

        public int moveToFirst()
                throws IllegalActionException
        Move this object to the first position in the list of attributes of the container. If this object is already first, do nothing. Increment the version of the workspace. This method overrides the base class to mirror the change in any mirror ports.
        Specified by:
        moveToFirst in interface Moveable
        Overrides:
        moveToFirst in class Port
        Returns:
        The index of the specified object prior to moving it, or -1 if it is not moved.
        Throws:
        IllegalActionException - If this object has no container.

      • moveToIndex

        public int moveToIndex​(int index)
                throws IllegalActionException
        Move this object to the specified position in the list of attributes of the container. If this object is already at the specified position, do nothing. This method overrides the base class to mirror the change in any mirror ports. Increment the version of the workspace.
        Specified by:
        moveToIndex in interface Moveable
        Overrides:
        moveToIndex in class Port
        Parameters:
        index - The position to move this object to.
        Returns:
        The index of the specified object prior to moving it, or -1 if it is not moved.
        Throws:
        IllegalActionException - If this object has no container or if the index is out of bounds.

      • moveToLast

        public int moveToLast()
               throws IllegalActionException
        Move this object to the last position in the list of attributes of the container. If this object is already last, do nothing. This method overrides the base class to mirror the change in any mirror ports. Increment the version of the workspace.
        Specified by:
        moveToLast in interface Moveable
        Overrides:
        moveToLast in class Port
        Returns:
        The index of the specified object prior to moving it, or -1 if it is not moved.
        Throws:
        IllegalActionException - If this object has no container.

      • moveUp

        public int moveUp()
           throws IllegalActionException
        Move this object up by one in the list of attributes of the container. If this object is already first, do nothing. This method overrides the base class to mirror the change in any mirror ports. Increment the version of the workspace.
        Specified by:
        moveUp in interface Moveable
        Overrides:
        moveUp in class Port
        Returns:
        The index of the specified object prior to moving it, or -1 if it is not moved.
        Throws:
        IllegalActionException - If this object has no container.

      • setInput

        public void setInput​(boolean isInput)
              throws IllegalActionException
        If the argument is true, make the port an input port. If the argument is false, make the port not an input port. This method overrides the base class to make the same change on the mirror ports in the controller and state refinments. This method invalidates the schedule and resolved types of the director of the container, if there is one. It is write-synchronized on the workspace, and increments the version of the workspace.
        Overrides:
        setInput in class IOPort
        Parameters:
        isInput - True to make the port an input.
        Throws:
        IllegalActionException - If changing the port status is not permitted.

      • setMirrorDisable

        public void setMirrorDisable​(boolean disable)
        Control whether any change should be mirrored in the modal model, mode controller, and refinements. This is added to allow control by the UI.
        Parameters:
        disable - True if mirroring should not occur.

      • setMultiport

        public void setMultiport​(boolean isMultiport)
                  throws IllegalActionException
        If the argument is true, make the port a multiport. If the argument is false, make the port not a multiport. This method overrides the base class to make the same change on the mirror ports in the controller and state refinments. This method invalidates the schedule and resolved types of the director of the container, if there is one. It is write-synchronized on the workspace, and increments the version of the workspace.
        Overrides:
        setMultiport in class IOPort
        Parameters:
        isMultiport - True to make the port a multiport.
        Throws:
        IllegalActionException - If changing the port status is not permitted.

      • setOutput

        public void setOutput​(boolean isOutput)
               throws IllegalActionException
        If the argument is true, make the port an output port. If the argument is false, make the port not an output port. In addition, if the container is an instance of Refinement, and the argument is true, find the corresponding port of the controller and make it an input and not an output. This makes it possible for the controller to see the outputs of the refinements. This method overrides the base class to make the same change on the mirror ports in the controller and state refinments. This method invalidates the schedule and resolved types of the director of the container, if there is one. It is write-synchronized on the workspace, and increments the version of the workspace.
        Overrides:
        setOutput in class IOPort
        Parameters:
        isOutput - True to make the port an output.
        Throws:
        IllegalActionException - If changing the port status is not permitted.