Class PortSite

  • All Implemented Interfaces:
    Site

    public class PortSite
    extends AbstractSite
    A site that locates itself on the bounds of a figure's shape, designed for placing ports.
    Since:
    Ptolemy II 2.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (johnr)
    Pt.ProposedRating:
    Red (eal)
    • Constructor Detail

      • PortSite

        public PortSite​(Figure figure,
                        Port port,
                        int number,
                        int count,
                        int direction)
        Create a new site on the given figure with the given ID port type, and port number.
        Parameters:
        figure - The figure for the entity icon.
        port - The port, which is ignored by this method
        number - The number of the port within its kind, starting with 0.
        count - The number of ports of its kind.
        direction - One of SwingConstants.{WEST, NORTH, EAST, SOUTH}.
    • Method Detail

      • getID

        public int getID()
        Return the ID for this site, which is the number of the port.
        Specified by:
        getID in interface Site
        Specified by:
        getID in class AbstractSite
        Returns:
        The number of the port.
      • getNormal

        public double getNormal()
        Get the normal of the site.
        Specified by:
        getNormal in interface Site
        Overrides:
        getNormal in class AbstractSite
        Returns:
        The normal.
      • getX

        public double getX()
        Get the x-coordinate of the site.
        Specified by:
        getX in interface Site
        Specified by:
        getX in class AbstractSite
        Returns:
        The x-coordinate of the site.
      • getY

        public double getY()
        Get the y-coordinate of the site.
        Specified by:
        getY in interface Site
        Specified by:
        getY in class AbstractSite
        Returns:
        The y-coordinate of the site.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object