FABulous.fabric_definition.SuperTile
====================================

.. py:module:: FABulous.fabric_definition.SuperTile

.. autoapi-nested-parse::
   Supertile definition for FPGA fabric.

   This module contains the `SuperTile` class, which represents a composite tile made
   up of multiple smaller, individual tiles. Supertiles allow for the creation of more
   larger, complex and hierarchical structures within the FPGA fabric, combining different
   functionalities into a single, reusable block.



Classes
-------

.. py:class:: SuperTile()

   Store the information about a super tile.

   .. attribute:: name

      The name of the super tile

      :type: str

   .. attribute:: tiles

      The list of tiles that make up the super tile

      :type: list[Tile]

   .. attribute:: tileMap

      The map of the tiles that make up the super tile

      :type: list[list[Tile]]

   .. attribute:: bels

      The list of bels of that the super tile contains

      :type: list[Bel]

   .. attribute:: withUserCLK

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

      :type: bool



   **Methods:**

   .. py:method:: getInternalConnections()

      Return all the internal connections of the supertile.

      :returns: **list** -- A list of tuples which contains the internal connected port
                and the x and y coordinate of the tile.
      :rtype: [tuple[list[Port], int, int]]


   .. py:method:: getPortsAroundTile()

      Return all the ports that are around the supertile.

      The dictionary key is the location of where the tile is located in the
      supertile map with the format of "X{x}Y{y}",
      where x is the x coordinate of the tile and y is the y coordinate of the tile.
      The top left tile will have key "00".

      :returns: **dict** -- The dictionary of the ports around the super tile.
      :rtype: [str, list[list[Port]]]