com.xilinx.rapidwright.design.blocks

Class PBlock

Object

AbstractCollection<E>

AbstractList<E>

ArrayList<PBlockRange>

com.xilinx.rapidwright.design.blocks.PBlock

All Implemented Interfaces:

Serializable, Cloneable, Iterable<PBlockRange>, Collection<PBlockRange>, List<PBlockRange>, RandomAccess

Direct Known Subclasses:

SubPBlock

public class PBlock
extends ArrayList<PBlockRange>

Represents a collection of one or more pblock ranges that describe a complete pblock Created on: Sep 16, 2016

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PBlock()
PBlock(Device dev, Set<Site> sites) Creates a new pblock object from a set of sites.
PBlock(Device dev, String pblock) Creates a new pblock object from a Vivado-style PBlock string.

Method Summary

Modifier and Type	Method and Description
void	addSubPBlock(SubPBlock subPBlock)
boolean	containRouting()
boolean	containsTile(Tile tile) Checks if this pblock includes the tile provided within its boundaries.
PBlock	createNewPblockAt(Site placement)
static PBlockRange	createPBlockRange(Device dev, Collection<Site> sites) Creates a pblock range for a specific site type namespace (all must be SLICE or DSP, no mixing).
Set<Site>	getAllSites(String prefix) Gets all sites inside the pblock
Set<Tile>	getAllTiles() Iterates over all Pblock ranges and returns the set of all tiles covered by the pblock.
Tile	getBottomLeftTile()
Tile	getBottomRightTile()
Device	getDevice()
String	getName()
PBlock	getParent()
List<SubPBlock>	getSubPBlocks()
ArrayList<String>	getTclConstraints()
Tile	getTopLeftTile()
Tile	getTopRightTile()
static boolean	isPBlockCornerSiteType(SiteTypeEnum type) Returns true if the provided site type is referenced in a pblock corner.
static void	main(String[] args)
boolean	movePBlock(int dx, int dy) Attempts to move the pblock by an offset of tiles in the x and y directions.
void	setContainRouting(boolean containRouting)
void	setName(String name)
void	setParent(PBlock parent)
String	toString()

Methods inherited from class ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class AbstractList

equals, hashCode

Methods inherited from class AbstractCollection

containsAll

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface List

containsAll, equals, hashCode

Methods inherited from interface Collection

parallelStream, stream

Constructor Detail

PBlock

public PBlock()

PBlock

public PBlock(Device dev,
              String pblock)

Creates a new pblock object from a Vivado-style PBlock string.

Parameters:

dev - The device for which to create the pblock.

pblock - The pblock string (SLICE_X0Y0:SLICE_X1Y1 ...)

PBlock

public PBlock(Device dev,
              Set<Site> sites)

Creates a new pblock object from a set of sites. Only supports used sites of type SLICE

Parameters:

dev - The device for which to create the pblock

sites - Set of SLICE sites to be included in the pblock and create a minimum rectangle size from those provided.

Method Detail

createPBlockRange

public static PBlockRange createPBlockRange(Device dev,
                                            Collection<Site> sites)

Creates a pblock range for a specific site type namespace (all must be SLICE or DSP, no mixing). The returned PBlockRange forms a Rectangle around the given Sites. Due to irregularities in the fabric, the corner Sites of the Rectangle may not actually exist. In this case, an exception will be thrown.

Parameters:

dev - The device onto which the pblock range should be created

sites - The list of homogeneous sites (all must be same type namespace).

Returns:

The minimum rectangle pblock range for the provided sites or null if no sites were given.

getTclConstraints

public ArrayList<String> getTclConstraints()

toString

public String toString()

Overrides:

toString in class AbstractCollection<PBlockRange>

getTopLeftTile

public Tile getTopLeftTile()

getBottomLeftTile

public Tile getBottomLeftTile()

getBottomRightTile

public Tile getBottomRightTile()

getTopRightTile

public Tile getTopRightTile()

getAllTiles

public Set<Tile> getAllTiles()

Iterates over all Pblock ranges and returns the set of all tiles covered by the pblock. The set of tiles is cached, so if underlying PBlockRange objects change since last called, this data will be stale.

Returns:

The set of all tiles in the pblock

getAllSites

public Set<Site> getAllSites(String prefix)

Gets all sites inside the pblock

Parameters:

prefix - Starting name of site type desired ("SLICE"). If null, returns all site types.

Returns:

All sites of a particular type

containsTile

public boolean containsTile(Tile tile)

Checks if this pblock includes the tile provided within its boundaries.

Parameters:

tile - The tile in question.

Returns:

True if the tile falls within the boundaries of the PBlock, false otherwise.

getDevice

public Device getDevice()

addSubPBlock

public void addSubPBlock(SubPBlock subPBlock)

getSubPBlocks

public List<SubPBlock> getSubPBlocks()

createNewPblockAt

public PBlock createNewPblockAt(Site placement)

Parameters:

placement -

Returns:

movePBlock

public boolean movePBlock(int dx,
                          int dy)

Attempts to move the pblock by an offset of tiles in the x and y directions.

Parameters:

dx - The number of tiles to move the pblock in the x direction.

dy - The number of tiles to mvoe the pblock in the y direction.

Returns:

True if the pblock ranges changed, false if no move was made.

main

public static void main(String[] args)

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getParent

public PBlock getParent()

Returns:

the parent

setParent

public void setParent(PBlock parent)

Parameters:

parent - the parent to set

containRouting

public boolean containRouting()

setContainRouting

public void setContainRouting(boolean containRouting)

isPBlockCornerSiteType

public static boolean isPBlockCornerSiteType(SiteTypeEnum type)

Returns true if the provided site type is referenced in a pblock corner.

Parameters:

type - The site type in question.

Returns:

True if it can be used as a pblock reference point, false otherwise.