com.xilinx.rapidwright.router

Class VersalClockTree

Object

com.xilinx.rapidwright.router.VersalClockTree

public class VersalClockTree
extends Object

For a given clock region Y coordinate domain range (e.g. Y1-Y5), provides a set of clock root options with corresponding vertical distribution paths for each target clock region.

Constructor Summary

Constructors

Constructor and Description
VersalClockTree() Only used for serialization purposes
VersalClockTree(int minY, int maxY)
VersalClockTree(int minY, int maxY, VTreeType vtreeType)

Method Summary

Modifier and Type	Method and Description
List<Pair<IntentCode,ClockRegion>>	getClockRegionVDistrPath(ClockRegion target) Gets the vertical distribution path of the target clock region for the preferred clock root.
List<Pair<IntentCode,ClockRegion>>	getClockRegionVDistrPath(ClockRegion target, int clockRootYCoord) Gets the vertical distribution path of the target clock region for the provided clock root.
Set<Integer>	getClockRootOptions()
Map<Integer,int[][]>	getClockRootPathSets()
int	getMaxY()
int	getMinMaxYKey()
static int	getMinMaxYRangeKey(int minY, int maxY)
static int	getMinMaxYRangeKey(int minY, int maxY, VTreeType vtreeType)
int	getMinY()
int	getPreferredClockRootYCoord()
VTreeType	getVTreeType()
static VTreeType	getVTreeType(int minMaxYKey)
void	setClockRootPathSets(Map<Integer,int[][]> clockRootPathSets)
void	setPreferredClockRootYCoord(int clockRootYCoord)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersalClockTree

public VersalClockTree()

Only used for serialization purposes

VersalClockTree

public VersalClockTree(int minY,
                       int maxY)

VersalClockTree

public VersalClockTree(int minY,
                       int maxY,
                       VTreeType vtreeType)

Method Detail

getMinY

public int getMinY()

getMaxY

public int getMaxY()

getMinMaxYKey

public int getMinMaxYKey()

getVTreeType

public VTreeType getVTreeType()

getPreferredClockRootYCoord

public int getPreferredClockRootYCoord()

setPreferredClockRootYCoord

public void setPreferredClockRootYCoord(int clockRootYCoord)

getClockRootPathSets

public Map<Integer,int[][]> getClockRootPathSets()

setClockRootPathSets

public void setClockRootPathSets(Map<Integer,int[][]> clockRootPathSets)

getClockRootOptions

public Set<Integer> getClockRootOptions()

getClockRegionVDistrPath

public List<Pair<IntentCode,ClockRegion>> getClockRegionVDistrPath(ClockRegion target)

Gets the vertical distribution path of the target clock region for the preferred clock root.

Parameters:

target - The destination clock region that needs to be routed via vertical distribution lines.

Returns:

A sequence of vertical distribution constraints (target IntentCode and ClockRegion).

getClockRegionVDistrPath

public List<Pair<IntentCode,ClockRegion>> getClockRegionVDistrPath(ClockRegion target,
                                                                   int clockRootYCoord)

Gets the vertical distribution path of the target clock region for the provided clock root.

Parameters:

target - The destination clock region that needs to be routed via vertical distribution lines.

clockRootYCoord - The desired clock root Y coordinate path set to use.

Returns:

A sequence of vertical distribution constraints (target IntentCode and ClockRegion).

getMinMaxYRangeKey

public static int getMinMaxYRangeKey(int minY,
                                     int maxY)

getMinMaxYRangeKey

public static int getMinMaxYRangeKey(int minY,
                                     int maxY,
                                     VTreeType vtreeType)

getVTreeType

public static VTreeType getVTreeType(int minMaxYKey)