Class ModalBasePort

  • All Implemented Interfaces:
    java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    Direct Known Subclasses:
    ModalPort, RefinementPort

    public class ModalBasePort
    extends TypedIOPort
    A base class that contains common functionality for ModelPort and ModalRefinementPort.

    ModalPort and RefinementPort both extend this class. ModalRefinementPort in turn extends RefinementPort. RefinementPort has different functionality for methods like setInput(), setMultiport(), setName() and setOutput(). Therefore, this base class defines protected versions of the common implementations of these methods that are called by the public versions of these methods in ModalPort and ModelRefinementPort, thus avoiding code duplication.

    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Christopher Brooks
    See Also:
    ModalPort, ModalRefinementPort
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)
    • Constructor Detail

      • ModalBasePort

        public ModalBasePort​(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.
      • ModalBasePort

        public ModalBasePort​(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

      • _moveDown

        protected 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.
        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

        protected 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.
        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

        protected 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.
        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

        protected 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.
        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

        protected 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.
        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

        protected 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.
        Parameters:
        isInput - True to make the port an input.
        Throws:
        IllegalActionException - If changing the port status is not permitted.
      • _setMultiport

        protected 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.
        Parameters:
        isMultiport - True to make the port a multiport.
        Throws:
        IllegalActionException - If changing the port status is not permitted.
      • _setName

        protected void _setName​(java.lang.String name)
                         throws IllegalActionException,
                                NameDuplicationException
        Set the name of the port, and mirror the change in all the mirror ports. This method is write-synchronized on the workspace, and increments the version of the workspace.
        Parameters:
        name - The name.
        Throws:
        IllegalActionException - If the name has a period.
        NameDuplicationException - If there is already a port with the same name in the container.
      • _setOutput

        protected 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. 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.
        Parameters:
        isOutput - True to make the port an output.
        Throws:
        IllegalActionException - If changing the port status is not permitted.
      • _checkContainer

        protected void _checkContainer​(Entity container)
                                throws IllegalActionException
        Override the base class to ensure that the proposed container is a CompositeEntity or null.
        Overrides:
        _checkContainer in class TypedIOPort
        Parameters:
        container - The proposed container.
        Throws:
        IllegalActionException - If the proposed container is not a TypedActor, or if the base class throws it.