FABulous.fabric_definition.Tile
===============================

.. py:module:: FABulous.fabric_definition.Tile

.. autoapi-nested-parse::
   Store information about a tile.



Classes
-------

.. py:class:: Tile(name, ports, bels, tileDir, matrixDir, gen_ios, userCLK, configBit = 0)

   Store information about a tile.

   .. attribute:: name

      The name of the tile

      :type: str

   .. attribute:: portsInfo

      The list of ports of the tile

      :type: list[Port]

   .. attribute:: matrixDir

      The directory of the tile matrix

      :type: str

   .. attribute:: gen_ios

      The list of GEN_IOs of the tile

      :type: List[Gen_IO]

   .. attribute:: matrixConfigBits

      The number of config bits the tile switch matrix has

      :type: int

   .. attribute:: withUserCLK

      Whether the tile has a userCLK port. Default is False.

      :type: bool

   .. attribute:: wireList

      The list of wires of the tile

      :type: list[Wire]

   .. attribute:: tileDir

      The path to the tile folder

      :type: str

   .. attribute:: Initialize a tile with its components.

      

   .. attribute:: 

      

      :type: param name: The name of the tile.

   .. attribute:: 

      

      :type: type name: str

   .. attribute:: 

      

      :type: param ports: List of ports for the tile.

   .. attribute:: 

      

      :type: type ports: list[Port]

   .. attribute:: 

      

      :type: param bels: List of Basic Elements of Logic (BELs) in the tile.

   .. attribute:: 

      

      :type: type bels: list[Bel]

   .. attribute:: 

      

      :type: param tileDir: Directory path for the tile.

   .. attribute:: 

      

      :type: type tileDir: pathlib.Path

   .. attribute:: 

      

      :type: param matrixDir: Directory path for the tile matrix.

   .. attribute:: 

      

      :type: type matrixDir: pathlib.Path

   .. attribute:: 

      

      :type: param gen_ios: List of general I/O components.

   .. attribute:: 

      

      :type: type gen_ios: list[Gen_IO]

   .. attribute:: 

      

      :type: param userCLK: True if the tile uses a clk signal.

   .. attribute:: 

      

      :type: type userCLK: bool

   .. attribute:: 

      

      :type: param configBit: Number of configuration bits for the switch matrix. Defaults to 0.

   .. attribute:: 

      

      :type: type configBit: int, optional



   **Properties:**

   .. py:property:: globalConfigBits

      Get the total number of global configuration bits.

      Calculates the sum of switch matrix configuration bits
      and all BEL configuration bits.

      :returns: Total number of global configuration bits for the tile.
      :rtype: int

   **Methods:**

   .. py:method:: getEastPorts(io)

      Get all ports with east wire direction filtered by I/O type.

      :param io: The I/O direction to filter by (INPUT or OUTPUT).
      :type io: IO

      :returns: List of east-direction ports with specified I/O type, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getEastSidePorts()

      Get all ports physically located on the east side of the tile.

      :returns: List of ports on the east side, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getNorthPorts(io)

      Get all ports with north wire direction filtered by I/O type.

      :param io: The I/O direction to filter by (INPUT or OUTPUT).
      :type io: IO

      :returns: List of north-direction ports with specified I/O type, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getNorthSidePorts()

      Get all ports physically located on the north side of the tile.

      :returns: List of ports on the north side, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getSouthPorts(io)

      Get all ports with south wire direction filtered by I/O type.

      :param io: The I/O direction to filter by (INPUT or OUTPUT).
      :type io: IO

      :returns: List of south-direction ports with specified I/O type, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getSouthSidePorts()

      Get all ports physically located on the south side of the tile.

      :returns: List of ports on the south side, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getTileInputNames()

      Get all input port destination names for the tile.

      :returns: List of destination names for input ports, excluding NULL and
                JUMP direction ports.
      :rtype: list[str]


   .. py:method:: getTileOutputNames()

      Get all output port source names for the tile.

      :returns: List of source names for output ports, excluding NULL and
                JUMP direction ports.
      :rtype: list[str]


   .. py:method:: getWestPorts(io)

      Get all ports with west wire direction filtered by I/O type.

      :param io: The I/O direction to filter by (INPUT or OUTPUT).
      :type io: IO

      :returns: List of west-direction ports with specified I/O type, excluding NULL ports.
      :rtype: list[Port]


   .. py:method:: getWestSidePorts()

      Get all ports physically located on the west side of the tile.

      :returns: List of ports on the west side, excluding NULL ports.
      :rtype: list[Port]