Module

Object
- com.xilinx.rapidwright.design.Module

All Implemented Interfaces:

Serializable
```
public class Module
extends Object
implements Serializable
```
Represents a collection of SiteInst and Net objects that can be instantiated as a ModuleInst. It serves as the prototype for a pre-implemented module.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`_placement_failed_anchor_error`
`static int`	`_placement_failed_anchor_null`
`static int`	`_placement_failed_corresponding_site`
`static int`	`_placement_failed_corresponding_tile`
`static boolean`	`_placement_failed_debug`
`static int`	`_placement_failed_instance_at_site`
`static int`	`_placement_failed_pip_mismatch`
`static String`	`CLK_MACRO_SUFFIX`
`static String`	`INPUT_FF_MACRO_SUFFIX`
`static String`	`INPUT_LUT_MACRO_SUFFIX`
`static String`	`INPUT_PORT_INNER_SUFFIX`
`static String`	`INPUT_PORT_SUFFIX`
`static String`	`OUTPUT_FF_MACRO_SUFFIX`
`static String`	`OUTPUT_LUT_MACRO_SUFFIX`
`static String`	`OUTPUT_PORT_INNER_SUFFIX`
`static String`	`OUTPUT_PORT_SUFFIX`

Constructor Summary

Constructors
Constructor and Description
`Module()` Empty constructor, strings are null, everything else is initialized
`Module(Design design)` Create a new module based on a design
`Module(Design design, boolean unrouteStaticNets)` Create a new module based on a design
`Module(Design design, String metadataFileName)` Create a new module based on the provided design and metadata file.
`Module(Design design, String metadataFileName, boolean unrouteStaticNets)` Create a new module based on the provided design and metadata file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCell(Cell c)` Adds a cell to the module
`void`	`addClock(String name, float period)` Adds a new clock to the module by name and period constraint
`void`	`addInst(SiteInst inst)` Adds an instance to this module.
`void`	`addNet(Net net)` Adds a net to this module.
`void`	`addPort(Port port)` Adds a port to this module.
`void`	`addValidPlacement(Site compatibleAnchorSite)` Explicitly add a valid placement for the module on the given device.
`ArrayList<Site>`	`calculateAllValidPlacements(Device dev)` Does a brute force search to find all valid locations of where this module can be placed.
`void`	`disconnectDesign()` Sets the design in all the module's instances to null
`boolean`	`equals(Object obj)`
`ArrayList<Site>`	`getAllValidPlacements()` Gets the previously calculated valid placement locations for this particular module.
`Site`	`getAnchor()` This gets and returns the instance anchor of the module.
`RelocatableTileRectangle`	`getBoundingBox()` Get the Bounding Box of all SiteInsts in this Module The Bounding Box is calculated once and cached for future calls of this method.
`Cell`	`getCell(String cellName)` Gets the named cell from the module
`HashMap<String,Float>`	`getClocks()` Gets a map of clocks and their period constraints in nanoseconds.
`Tile`	`getCorrespondingAnchorTile(Tile templateTile, Tile newTile, Device dev)` This method allows calculates the proposed anchor tile if the templateTile within the module is placed at the newTile location.
`Site`	`getCorrespondingSite(SiteInst inst, Site anchorSite)` Get the corresponding Site of the given SiteInst if the module is relocated.
`Tile`	`getCorrespondingTile(Tile templateTile, Tile newAnchorTile)` This method will calculate and return the corresponding tile of a module for a new anchor location.
`static Tile`	`getCorrespondingTile(Tile templateTile, Tile newAnchorTile, Tile originalAnchor)` This method will calculate and return the corresponding tile of a module for a new anchor location for a given anchor location.
`static Tile`	`getCorrespondingTile(Tile templateTile, Tile newAnchorTile, Tile originalAnchor, Tile[][] tiles)` This method will calculate and return the corresponding tile of a module for a new anchor location for a given anchor location.
`Device`	`getDevice()` Gets the device object used by this module
`int`	`getImplementationIndex()`
`Map<String,String>`	`getMetaDataMap()`
`float`	`getMinClkPeriod()`
`String`	`getName()` Gets and returns the current name of this module
`Net`	`getNet(String name)` Gets and returns the net in the module called name.
`EDIFNetlist`	`getNetlist()` Gets the module's corresponding logical EDIF netlist
`Collection<Net>`	`getNets()` Gets and returns all the nets that are part of the module.
`NOCDesign`	`getNOCDesign()` Gets the current NOC Design corresponding to this module
`PBlock`	`getPBlock()` Gets the stored pblock used to create the module (if any)
`String`	`getPBlockString()` Gets the stored pblock String used to create the module (if any)
`Port`	`getPort(String name)` Returns the port with the given name.
`Collection<Port>`	`getPorts()` Gets and returns the port list for this module.
`SiteInst`	`getSiteInst(String name)` Gets and returns the instance in the module called name.
`SiteInst`	`getSiteInstAtSite(Site site)` Gets the module site instance at the specified site
`Collection<SiteInst>`	`getSiteInsts()` Gets and returns all of the instances part of this module.
`String`	`getSrcDatFile()` Gets the .dat filename used to populate this module
`int`	`getTileFootprintSize()` Returns the total number of tiles occupied by this module (sites and PIPs)
`int`	`hashCode()`
`boolean`	`isValidPlacement(Site proposedAnchorSite, Design design)` Checks if the new proposed anchor site on this module is compatible with all of its internal sites.
`void`	`removeNet(Net net)` Removes a net from the design
`void`	`removeNet(String name)` Removes a net from the design
`boolean`	`removeSiteInst(SiteInst instance)` This method carefully removes an instance in a design with its pins and possibly nets.
`boolean`	`removeSiteInst(String name)` This method carefully removes an instance in a design with its pins and possibly nets.
`static void`	`reportValidPlacementStats()` A debug reporting mechanism that will print stats on reasons for attempted placement failures.
`void`	`setAnchor(Site anchor)` Sets the anchor instance for this module.
`void`	`setClocks(HashMap<String,Float> clocks)` Sets a map of clocks and their period constraints in nanoseconds.
`void`	`setDevice(Device dev)` Sets the specified device for this module
`void`	`setImplementationIndex(int implementationIndex)`
`void`	`setMetaDataMap(HashMap<String,String> metaDataMap)`
`void`	`setMinClkPeriod(float minClkPeriod)`
`void`	`setName(String name)` Sets the name of this module
`void`	`setNetlist(EDIFNetlist netlist)` Sets the netlist for the module
`void`	`setNOCDesign(NOCDesign nocDesign)` Sets the NOC Design containing client metadata for the module
`void`	`setPBlock(PBlock pblock)` Allows the user to store the pblock used to create the module
`void`	`setPBlock(String pblock)` Allows the user to store the pblock used to create the module from String representation
`void`	`setPorts(ArrayList<Port> portList)` Sets the port list for this module.
`void`	`setSrcDatFile(String srcDatFile)` Sets the .dat filename used to populate this module
`void`	`setValidPlacements(ArrayList<Site> placements)` Manually set the valid placements for this module.
`String`	`toString()`

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INPUT_PORT_SUFFIX
```
public static final String INPUT_PORT_SUFFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_PORT_INNER_SUFFIX
```
public static final String INPUT_PORT_INNER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_PORT_SUFFIX
```
public static final String OUTPUT_PORT_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_PORT_INNER_SUFFIX
```
public static final String OUTPUT_PORT_INNER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - CLK_MACRO_SUFFIX
```
public static final String CLK_MACRO_SUFFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_FF_MACRO_SUFFIX
```
public static final String INPUT_FF_MACRO_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_FF_MACRO_SUFFIX
```
public static final String OUTPUT_FF_MACRO_SUFFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_LUT_MACRO_SUFFIX
```
public static final String INPUT_LUT_MACRO_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_LUT_MACRO_SUFFIX
```
public static final String OUTPUT_LUT_MACRO_SUFFIX
```
    See Also:
    
    Constant Field Values
  - _placement_failed_anchor_null
```
public static int _placement_failed_anchor_null
```
  - _placement_failed_anchor_error
```
public static int _placement_failed_anchor_error
```
  - _placement_failed_corresponding_tile
```
public static int _placement_failed_corresponding_tile
```
  - _placement_failed_corresponding_site
```
public static int _placement_failed_corresponding_site
```
  - _placement_failed_instance_at_site
```
public static int _placement_failed_instance_at_site
```
  - _placement_failed_pip_mismatch
```
public static int _placement_failed_pip_mismatch
```
  - _placement_failed_debug
```
public static boolean _placement_failed_debug
```
- Constructor Detail
  - Module
```
public Module()
```
    Empty constructor, strings are null, everything else is initialized
    
    Since:
    
    2018.2.0
  - Module
```
public Module(Design design,
              String metadataFileName)
```
    Create a new module based on the provided design and metadata file.
    
    Parameters:
    
    design - The prototype design to use for the module
    
    metadataFileName - The associated metadata file (created from the Tcl command in rapidwright.tcl/generate_metadata() ).
    
    Since:
    
    2018.2.0
  - Module
```
public Module(Design design,
              String metadataFileName,
              boolean unrouteStaticNets)
```
    Create a new module based on the provided design and metadata file.
    
    Parameters:
    
    design - The prototype design to use for the module
    
    metadataFileName - The associated metadata file (created from the Tcl command in rapidwright.tcl/generate_metadata() ).
    
    unrouteStaticNets - A flag denoting if Vcc and Gnd nets should be unrouted.
    
    Since:
    
    2021.2.2
  - Module
```
public Module(Design design)
```
    Create a new module based on a design
    
    Parameters:
    
    design - The prototype design
    
    Since:
    
    2018.2.0
  - Module
```
public Module(Design design,
              boolean unrouteStaticNets)
```
    Create a new module based on a design
    
    Parameters:
    
    design - The prototype design
    
    unrouteStaticNets - A flag denoting if Vcc and Gnd nets should be unrouted.
    
    Since:
    
    2021.2.2
- Method Detail
  - setName
```
public void setName(String name)
```
    Sets the name of this module
    
    Parameters:
    
    name - New name for this module
    
    Since:
    
    2018.2.0
  - getName
```
public String getName()
```
    Gets and returns the current name of this module
    
    Returns:
    
    The current name of this module
    
    Since:
    
    2018.2.0
  - getAnchor
```
public Site getAnchor()
```
    This gets and returns the instance anchor of the module.
    
    Returns:
    
    site instance which is the anchor for this module.
    
    Since:
    
    2018.2.0
  - getImplementationIndex
```
public int getImplementationIndex()
```
    Returns:
    
    the implementationIndex
    
    Since:
    
    2018.2.0
  - setImplementationIndex
```
public void setImplementationIndex(int implementationIndex)
```
    Parameters:
    
    implementationIndex - the implementationIndex to set
    
    Since:
    
    2018.2.0
  - getSiteInst
```
public SiteInst getSiteInst(String name)
```
    Gets and returns the instance in the module called name.
    
    Parameters:
    
    name - Name of the instance in the module to get.
    
    Returns:
    
    The instance name or null if it does not exist.
    
    Since:
    
    2018.2.0
  - getSiteInsts
```
public Collection<SiteInst> getSiteInsts()
```
    Gets and returns all of the instances part of this module.
    
    Returns:
    
    The instances that are part of this module.
    
    Since:
    
    2018.2.0
  - getNet
```
public Net getNet(String name)
```
    Gets and returns the net in the module called name.
    
    Parameters:
    
    name - Name of the net in the module to get.
    
    Returns:
    
    The net name or null if it does not exist.
    
    Since:
    
    2018.2.0
  - getNets
```
public Collection<Net> getNets()
```
    Gets and returns all the nets that are part of the module.
    
    Returns:
    
    The nets that are part of this module.
    
    Since:
    
    2018.2.0
  - removeNet
```
public void removeNet(String name)
```
    Removes a net from the design
    
    Parameters:
    
    name - The name of the net to remove.
    
    Since:
    
    2018.2.0
  - removeNet
```
public void removeNet(Net net)
```
    Removes a net from the design
    
    Parameters:
    
    net - The net to remove from the design.
    
    Since:
    
    2018.2.0
  - removeSiteInst
```
public boolean removeSiteInst(String name)
```
    This method carefully removes an instance in a design with its pins and possibly nets. Nets are only removed if they are empty after removal of the instance's pins. This method CANNOT remove instances that are part of a ModuleInst.
    
    Parameters:
    
    name - The instance name in the module to remove.
    
    Returns:
    
    True if the operation was successful, false otherwise.
    
    Since:
    
    2018.2.0
  - removeSiteInst
```
public boolean removeSiteInst(SiteInst instance)
```
    This method carefully removes an instance in a design with its pins and possibly nets. Nets are only removed if they are empty after removal of the instance's pins. This method CANNOT remove instances that are part of a ModuleInst.
    
    Parameters:
    
    instance - The instance in the design to remove.
    
    Returns:
    
    True if the operation was successful, false otherwise.
    
    Since:
    
    2018.2.0
  - setAnchor
```
public void setAnchor(Site anchor)
```
    Sets the anchor instance for this module.
    
    Parameters:
    
    anchor - New anchor Site for this module.
    
    Since:
    
    2018.2.0
  - getPorts
```
public Collection<Port> getPorts()
```
    Gets and returns the port list for this module.
    
    Returns:
    
    The port list for this module.
    
    Since:
    
    2018.2.0
  - setPorts
```
public void setPorts(ArrayList<Port> portList)
```
    Sets the port list for this module.
    
    Parameters:
    
    portList - The new port list to be set for this module.
    
    Since:
    
    2018.2.0
  - addPort
```
public void addPort(Port port)
```
    Adds a port to this module.
    
    Parameters:
    
    port - The new port to add.
    
    Since:
    
    2018.2.0
  - getPort
```
public Port getPort(String name)
```
    Returns the port with the given name.
    
    Parameters:
    
    name - the port's name
    
    Returns:
    
    the port
    
    Since:
    
    2018.2.0
  - addNet
```
public void addNet(Net net)
```
    Adds a net to this module.
    
    Parameters:
    
    net - The net to add to the module.
    
    Since:
    
    2018.2.0
  - addInst
```
public void addInst(SiteInst inst)
```
    Adds an instance to this module.
    
    Parameters:
    
    inst - The instance to add to the module.
    
    Since:
    
    2018.2.0
  - getMetaDataMap
```
public Map<String,String> getMetaDataMap()
```
    Returns:
    
    the metaDataMap
    
    Since:
    
    2018.2.2
  - setMetaDataMap
```
public void setMetaDataMap(HashMap<String,String> metaDataMap)
```
    Parameters:
    
    metaDataMap - the metaDataMap to set
    
    Since:
    
    2018.2.2
  - setMinClkPeriod
```
public void setMinClkPeriod(float minClkPeriod)
```
    Parameters:
    
    minClkPeriod - the minClkPeriod to set
    
    Since:
    
    2018.2.0
  - getMinClkPeriod
```
public float getMinClkPeriod()
```
    Returns:
    
    the minClkPeriod
    
    Since:
    
    2018.2.0
  - disconnectDesign
```
public void disconnectDesign()
```
    Sets the design in all the module's instances to null
    
    Since:
    
    2018.2.0
  - getSiteInstAtSite
```
public SiteInst getSiteInstAtSite(Site site)
```
    Gets the module site instance at the specified site
    
    Parameters:
    
    site - The site of interest
    
    Returns:
    
    The site instance in this module residing at the specified site or null if none exist.
    
    Since:
    
    2018.2.0
  - calculateAllValidPlacements
```
public ArrayList<Site> calculateAllValidPlacements(Device dev)
```
    Does a brute force search to find all valid locations of where this module can be placed.
    
    Returns:
    
    A list of valid anchor sites for the module to be placed.
    
    Since:
    
    2018.2.0
  - getAllValidPlacements
```
public ArrayList<Site> getAllValidPlacements()
```
    Gets the previously calculated valid placement locations for this particular module.
    
    Returns:
    
    A list of anchor sites which are valid for this module.
    
    Since:
    
    2018.2.0
    
    See Also:
    
    Cell.getCompatiblePlacements(Device)
  - setValidPlacements
```
public void setValidPlacements(ArrayList<Site> placements)
```
    Manually set the valid placements for this module. Useful when filtering out locations that are undesirable.
    
    Parameters:
    
    placements - The list of valid placements to be set for this module.
  - getTileFootprintSize
```
public int getTileFootprintSize()
```
    Returns the total number of tiles occupied by this module (sites and PIPs)
    
    Returns:
    
    The total number of tiles occupied by this module
    
    Since:
    
    2018.2.0
  - reportValidPlacementStats
```
public static void reportValidPlacementStats()
```
    A debug reporting mechanism that will print stats on reasons for attempted placement failures. In order for statistics to be gathered for the module, the flag Module._placement_failed_debug must be set to true.
    
    Since:
    
    2018.2.0
  - isValidPlacement
```
public boolean isValidPlacement(Site proposedAnchorSite,
                                Design design)
```
    Checks if the new proposed anchor site on this module is compatible with all of its internal sites. Optionally, it can also check if there are existing sites already placed at the proposed location.
    
    Parameters:
    
    proposedAnchorSite - The proposed new anchor site
    
    design - OPTIONAL - if non-null, will check against currently placed sites (TODO, also should check against PIPs)
    
    Returns:
    
    True if it is a valid, legal placement. False otherwise.
    
    Since:
    
    2020.2.5
  - getCorrespondingTile
```
public Tile getCorrespondingTile(Tile templateTile,
                                 Tile newAnchorTile)
```
    This method will calculate and return the corresponding tile of a module for a new anchor location.
    
    Parameters:
    
    templateTile - The tile in the module which acts as a template.
    
    newAnchorTile - This is the tile of the new anchor instance of the module.
    
    Returns:
    
    The new tile of the module instance which corresponds to the templateTile, or null if none exists.
    
    Since:
    
    2020.2.5
  - getCorrespondingTile
```
public static Tile getCorrespondingTile(Tile templateTile,
                                        Tile newAnchorTile,
                                        Tile originalAnchor,
                                        Tile[][] tiles)
```
    This method will calculate and return the corresponding tile of a module for a new anchor location for a given anchor location. This method is faster than Module.getCorrespondingTile(Tile, Tile, Tile) when doing many relocations of the same template. Calling code needs to cache the return value of newAnchorTile.getDevice().getTilesByRootName(templateTile.getRootName()) and supply it as parameter tiles.
    
    Parameters:
    
    templateTile - The tile in the module which acts as a template.
    
    newAnchorTile - This is the tile of the new anchor instance of the module.
    
    originalAnchor - Location of the anchor origin.
    
    tiles - The Tiles with the same Name Root as templateTile, as returned by Device.getTilesByRootName(String)
    
    Returns:
    
    The new tile of the module instance which corresponds to the templateTile, or null if none exists.
    
    Since:
    
    2020.2.6
  - getCorrespondingTile
```
public static Tile getCorrespondingTile(Tile templateTile,
                                        Tile newAnchorTile,
                                        Tile originalAnchor)
```
    This method will calculate and return the corresponding tile of a module for a new anchor location for a given anchor location. When doing many relocations of the same template, consider using Module.getCorrespondingTile(Tile, Tile, Tile, Tile[][])
    
    Parameters:
    
    templateTile - The tile in the module which acts as a template.
    
    newAnchorTile - This is the tile of the new anchor instance of the module.
    
    originalAnchor - Location of the anchor origin.
    
    Returns:
    
    The new tile of the module instance which corresponds to the templateTile, or null if none exists.
    
    Since:
    
    2018.2.0
  - getCorrespondingAnchorTile
```
public Tile getCorrespondingAnchorTile(Tile templateTile,
                                       Tile newTile,
                                       Device dev)
```
    This method allows calculates the proposed anchor tile if the templateTile within the module is placed at the newTile location.
    
    Parameters:
    
    templateTile - The tile within the module to act as reference.
    
    newTile - The proposed place to move the templateTile to.
    
    dev - The current device.
    
    Returns:
    
    The new anchor tile if the templateTile is placed on newTile.
    
    Since:
    
    2018.2.0
  - getCorrespondingSite
```
public Site getCorrespondingSite(SiteInst inst,
                                 Site anchorSite)
```
    Get the corresponding Site of the given SiteInst if the module is relocated.
    
    Parameters:
    
    inst - The SiteInst to relocate
    
    anchorSite - The target location of the module anchor.
    
    Returns:
    
    The corresponding site or null if none is available.
    
    Since:
    
    2021.2.2
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addCell
```
public void addCell(Cell c)
```
    Adds a cell to the module
    
    Parameters:
    
    c - The cell to add
    
    Since:
    
    2018.2.0
  - getCell
```
public Cell getCell(String cellName)
```
    Gets the named cell from the module
    
    Parameters:
    
    cellName - Name of the cell to get
    
    Returns:
    
    The named cell or null if it could not be found.
    
    Since:
    
    2023.1.4
  - getDevice
```
public Device getDevice()
```
    Gets the device object used by this module
    
    Returns:
    
    The device
    
    Since:
    
    2018.2.0
  - setDevice
```
public void setDevice(Device dev)
```
    Sets the specified device for this module
    
    Parameters:
    
    dev - The desired device for this module
    
    Since:
    
    2018.2.0
  - getNetlist
```
public EDIFNetlist getNetlist()
```
    Gets the module's corresponding logical EDIF netlist
    
    Returns:
    
    the logical EDIF netlist of the module
    
    Since:
    
    2018.2.0
  - setNetlist
```
public void setNetlist(EDIFNetlist netlist)
```
    Sets the netlist for the module
    
    Parameters:
    
    netlist - The desired netlist for the module
    
    Since:
    
    2018.2.0
  - setNOCDesign
```
public void setNOCDesign(NOCDesign nocDesign)
```
    Sets the NOC Design containing client metadata for the module
    
    Parameters:
    
    nocDesign - The NOC design for the module
    
    Since:
    
    2022.1.0
  - getNOCDesign
```
public NOCDesign getNOCDesign()
```
    Gets the current NOC Design corresponding to this module
    
    Returns:
    
    Current NOC Design
    
    Since:
    
    2022.1.0
  - getPBlock
```
public PBlock getPBlock()
```
    Gets the stored pblock used to create the module (if any)
    
    Returns:
    
    The pblock if one was used to create the module, or null if none.
    
    Since:
    
    2018.2.2
  - getPBlockString
```
public String getPBlockString()
```
    Gets the stored pblock String used to create the module (if any)
    
    Returns:
    
    The pblock if one was used to create the module, or null if none.
    
    Since:
    
    2018.2.2
  - setPBlock
```
public void setPBlock(String pblock)
```
    Allows the user to store the pblock used to create the module from String representation
    
    Parameters:
    
    pblock - The pblock used to create the module
    
    Since:
    
    2018.2.0
  - setPBlock
```
public void setPBlock(PBlock pblock)
```
    Allows the user to store the pblock used to create the module
    
    Parameters:
    
    pblock - The pblock used to create the module
    
    Since:
    
    2018.2.2
  - getClocks
```
public HashMap<String,Float> getClocks()
```
    Gets a map of clocks and their period constraints in nanoseconds.
    
    Returns:
    
    Map of clock names to their period constraints in nanoseconds.
    
    Since:
    
    2018.2.0
  - setClocks
```
public void setClocks(HashMap<String,Float> clocks)
```
    Sets a map of clocks and their period constraints in nanoseconds.
    
    Parameters:
    
    clocks - Map of clock names to period constraints in nanoseconds
    
    Since:
    
    2018.2.0
  - addClock
```
public void addClock(String name,
                     float period)
```
    Adds a new clock to the module by name and period constraint
    
    Parameters:
    
    name - Name of the clock to add
    
    period - Clock period constraint in nanoseconds
    
    Since:
    
    2018.2.0
  - addValidPlacement
```
public void addValidPlacement(Site compatibleAnchorSite)
```
    Explicitly add a valid placement for the module on the given device.
    
    Parameters:
    
    compatibleAnchorSite - The anchor site for the valid location.
    
    Since:
    
    2018.2.0
  - getSrcDatFile
```
public String getSrcDatFile()
```
    Gets the .dat filename used to populate this module
    
    Returns:
    
    File name of the .dat file used to populate this module or null if none used.
    
    Since:
    
    2018.2.0
  - setSrcDatFile
```
public void setSrcDatFile(String srcDatFile)
```
    Sets the .dat filename used to populate this module
    
    Parameters:
    
    srcDatFile - The .dat filename used to populate this module
    
    Since:
    
    2018.2.0
  - getBoundingBox
```
public RelocatableTileRectangle getBoundingBox()
```
    Get the Bounding Box of all SiteInsts in this Module The Bounding Box is calculated once and cached for future calls of this method.
    
    Returns:
    
    Bounding Box
    
    Since:
    
    2020.2.4

Class Module

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

INPUT_PORT_SUFFIX

INPUT_PORT_INNER_SUFFIX

OUTPUT_PORT_SUFFIX

OUTPUT_PORT_INNER_SUFFIX

CLK_MACRO_SUFFIX

INPUT_FF_MACRO_SUFFIX

OUTPUT_FF_MACRO_SUFFIX

INPUT_LUT_MACRO_SUFFIX

OUTPUT_LUT_MACRO_SUFFIX

_placement_failed_anchor_null

_placement_failed_anchor_error

_placement_failed_corresponding_tile

_placement_failed_corresponding_site

_placement_failed_instance_at_site

_placement_failed_pip_mismatch

_placement_failed_debug

Constructor Detail

Module

Module

Module

Module

Module

Method Detail

setName

getName

getAnchor

getImplementationIndex

setImplementationIndex

getSiteInst

getSiteInsts

getNet

getNets

removeNet

removeNet

removeSiteInst

removeSiteInst

setAnchor

getPorts

setPorts

addPort

getPort

addNet

addInst

getMetaDataMap

setMetaDataMap

setMinClkPeriod

getMinClkPeriod

disconnectDesign

getSiteInstAtSite

calculateAllValidPlacements

getAllValidPlacements

setValidPlacements

getTileFootprintSize

reportValidPlacementStats

isValidPlacement

getCorrespondingTile

getCorrespondingTile

getCorrespondingTile

getCorrespondingAnchorTile

getCorrespondingSite

hashCode

equals

toString

addCell

getCell

getDevice

setDevice

getNetlist

setNetlist

setNOCDesign

getNOCDesign

getPBlock

getPBlockString

setPBlock