FABulous.geometry_generator.fabric_geometry
===========================================

.. py:module:: FABulous.geometry_generator.fabric_geometry

.. autoapi-nested-parse::
   Classes for generating and managing the geometry of FPGA fabrics.



Classes
-------

.. py:class:: FabricGeometry(fabric, padding = 8)

   Fetch and hold geometric information about a fabric.

   Objects of this class can be constructed by passing a `Fabric` object
   and optionally, padding.

   .. attribute:: fabric

      The fabric object passed from the CSV definition files

      :type: Fabric

   .. attribute:: tileNames

      Set of unique tileNames in the fabric

      :type: Set[str]

   .. attribute:: tileGeomMap

      Map of the geometry of each tile by name

      :type: Dict[str, TileGeometry]

   .. attribute:: tileLocs

      Locations of all tiles in the fabric

      :type: List[List[Location]]

   .. attribute:: padding

      Padding used throughout the geometry, in multiples of the width between wires

      :type: int

   .. attribute:: width

      Width of the fabric

      :type: int

   .. attribute:: height

      Height of the fabric

      :type: int

   .. attribute:: Initialize a FabricGeometry instance.

      

   .. attribute:: Creates the fabric geometry by processing the given fabric definition

      

   .. attribute:: and automatically generating the complete geometric layout.

      

   .. attribute:: 

      

      :type: param fabric: The fabric object from CSV definition files

   .. attribute:: 

      

      :type: type fabric: Fabric

   .. attribute:: 

      

      :type: param padding: Padding used throughout the geometry, by default 8

   .. attribute:: 

      

      :type: type padding: int, optional



   **Methods:**

   .. py:method:: generateGeometry()

      Generate the geometric information from the given fabric object.

      The border attribute is set for tiles that are located at a border of the tile.
      This is done to ensure no stair-like wires being generated for these tiles. The
      distinction left/right and top/bottom is made, to prevent generation of
      horizontal and vertical stair-like wires respectively.


   .. py:method:: saveToCSV(fileName)

      Save geometric information of the given fabric for the graphical frontend.

      :param fileName: The name of the csv file
      :type fileName: str