com.xilinx.rapidwright.util

Class CodeGenerator

Object

com.xilinx.rapidwright.util.CodeGenerator

public class CodeGenerator
extends Object

This utility class is used to create RapidWright code from a DCP file that is tedious to create by hand.

Constructor Summary

Constructors

Constructor and Description
CodeGenerator()

Method Summary

Modifier and Type	Method and Description
static void	addPIPs(Net net, String[] pips)
static Net	createTestNet(Design design, String netName, String[] pips)
static String	testNetGenerator(Design design, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.
static String	testNetGenerator(Net net) Convenience method to take a net and return a String the generates the routed net for an example test case in RapidWright code
static String	testNetGenerator(String dcp, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.
static String	testNetGenerator(String dcp, String edif, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Methods inherited from class Object

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

Constructor Detail

CodeGenerator

public CodeGenerator()

Method Detail

testNetGenerator

public static String testNetGenerator(Net net)

Convenience method to take a net and return a String the generates the routed net for an example test case in RapidWright code

Parameters:

net - The net to extract routing and SiteInst from

Returns:

The RapidWright code string

testNetGenerator

public static String testNetGenerator(String dcp,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

dcp - The path to the desired DCP to generate code from.

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

testNetGenerator

public static String testNetGenerator(String dcp,
                                      String edif,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

dcp - The path to the desired DCP to generate code from.

edif - The path to the external EDIF file to load (in case of an encrypted DCP file).

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

testNetGenerator

public static String testNetGenerator(Design design,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

design - The design to generate code from.

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

createTestNet

public static Net createTestNet(Design design,
                                String netName,
                                String[] pips)

addPIPs

public static void addPIPs(Net net,
                           String[] pips)