com.xilinx.rapidwright.util

Class Params

Object

com.xilinx.rapidwright.util.Params

public class Params
extends Object

Aims to be a centralized helper class to manage global RapidWright settings.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK Flag to have RapidWright decompress gzipped EDIF files to disk prior to parsing.
static String	RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME

Constructor Summary

Constructors

Constructor and Description
Params()

Method Summary

Modifier and Type	Method and Description
static boolean	isParamSet(String key) Checks if the named RapidWright parameter is set via an environment variable or by a JVM parameter of the same name.
static boolean	isSet(String value) Checks if a parameter is set by examining the provided value.

Methods inherited from class Object

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

Field Detail

RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME

public static String RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK_NAME

RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK

public static boolean RW_DECOMPRESS_GZIPPED_EDIF_TO_DISK

Flag to have RapidWright decompress gzipped EDIF files to disk prior to parsing. This is a tradeoff where pre-decompression improves runtime over the default method which is to decompress in memory. The disadvantage is that this will temporarily consume ~18x more disk space than original gzipped EDIF file, but loading of the EDIF file will be ~2x faster.

Constructor Detail

Params

public Params()

Method Detail

isParamSet

public static boolean isParamSet(String key)

Checks if the named RapidWright parameter is set via an environment variable or by a JVM parameter of the same name.

Parameters:

key - Name of the global RapidWright parameter

Returns:

True if the parameter is set (as defined by Params.isSet(String)), false otherwise

isSet

public static boolean isSet(String value)

Checks if a parameter is set by examining the provided value.

Parameters:

value - An environment variable or JVM parameter value

Returns:

True if (1) value is not null, (2) is not an empty string, (3) is not 0 and (4) is not false (case-insensitive).