EDIFNetlist

Object
- com.xilinx.rapidwright.edif.EDIFName
- - com.xilinx.rapidwright.edif.EDIFNetlist

All Implemented Interfaces:

Comparable<EDIFName>
```
public class EDIFNetlist
extends EDIFName
```
Top level object for a (logical) EDIF netlist. Created on: May 11, 2017

Field Summary

Fields
Modifier and Type	Field and Description
`static EDIFPropertyValue`	`DEFAULT_PROP_VALUE`
`static byte[]`	`EXPORT_CONST_CELLREF`
`static byte[]`	`EXPORT_CONST_CLOSE_DESIGN`
`static byte[]`	`EXPORT_CONST_CLOSE_EDIF`
`static byte[]`	`EXPORT_CONST_CLOSE_NL`
`static byte[]`	`EXPORT_CONST_CLOSE_REF`
`static byte[]`	`EXPORT_CONST_COMMENT`
`static byte[]`	`EXPORT_CONST_DESIGN_START`
`static byte[]`	`EXPORT_CONST_DOUBLE_CLOSE`
`static byte[]`	`EXPORT_CONST_EDIF_HEAD`
`static byte[]`	`EXPORT_CONST_EDIF_VERSION`
`static byte[]`	`EXPORT_CONST_LIBRARYREF`
`static byte[]`	`EXPORT_CONST_META_X`
`static byte[]`	`EXPORT_CONST_PROGRAM`
`static byte[]`	`EXPORT_CONST_PROP_INDENT`
`static byte[]`	`EXPORT_CONST_QUOTE_CLOSE_NL`
`static String`	`IOSTANDARD_PROP`
`static Map<Series,Map<String,Pair<String,EnumSet<IOStandard>>>>`	`macroCollapseExceptionMap` Reverse map that stores macro to prim collapse conditional based on IOStandards (Macro to Prim (if set IOStandard is in set))
`static Map<Series,Map<String,Pair<String,EnumSet<IOStandard>>>>`	`macroExpandExceptionMap` Map that stores prim to macro expansions conditional based on IOStandards (Start Prim to End Macro (if set IOStandard is in set))
`static String`	`READ_EDIF_CMD`

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName
EXPORT_CONST_RENAME_START

Constructor Summary

Constructors
Constructor and Description

EDIFNetlist(String name)

Constructors
Constructor and Description
`EDIFNetlist(String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addComment(String comment)`
`void`	`addEncryptedCells(List<String> encryptedCells)`
`EDIFLibrary`	`addLibrary(EDIFLibrary library)` Adds the library to this netlist.
`EDIFPropertyValue`	`addMetax(String key, EDIFPropertyValue value)`
`void`	`addTclLoadEncryptedCells(Path tclPath)` Parses a Tcl load script generated by `EDIFTools.writeTclLoadScriptForPartialEncryptedDesigns(EDIFNetlist, Path, String)`.
`void`	`addTrackingChange(EDIFCell cell, EDIFChange change)`
`void`	`changeTopName(String newName)` Will change the netlist name and top cell and instance name.
`void`	`collapseMacroUnisims(Series series)` Collapses any macro primitives back into their primitive state.
`void`	`consolidateAllToWorkLibrary()` Migrates all libraries except HDI primitives and work to the work library.
`void`	`copyCellAndSubCells(EDIFCell cell)` This copies the cell and all of its descendants into this netlist.
`EDIFLibrary`	`copyLibraryAndSubCells(EDIFLibrary library)` This copies the library and all of its cells into this netlist.
`void`	`expandMacroUnisims(Series series)` Expands macro primitives into a native-compatible implementation.
`void`	`exportEDIF(OutputStream out)`
`void`	`exportEDIF(OutputStream out, boolean stable)`
`void`	`exportEDIF(Path fileName)`
`void`	`exportEDIF(Path fileName, boolean stable)`
`void`	`exportEDIF(String fileName)`
`List<EDIFHierCellInst>`	`findCellInsts(String wildcardPattern)` Searches all EDIFCellInst objects to find those with matching names against the wildcard pattern.
`void`	`generateBuildComments()` Adds date and username build comments such as: (comment "Built on 'Mon May 1 15:17:36 PDT 2017'") (comment "Built by 'clavin'")
`HashMap<String,EDIFCellInst>`	`generateCellInstMap()` Identify primitive cell instances in EDIF netlist
`HashMap<String,EDIFNet>`	`generateEDIFNetMap(HashMap<String,EDIFCellInst> cellInstMap)`
`List<EDIFHierCellInst>`	`getAllDescendants(String instanceName, String wildcardPattern, boolean leavesOnly)` Searches all lower levels of hierarchy to find descendants.
`List<EDIFCellInst>`	`getAllLeafCellInstances()` Traverses the netlist and produces a list of all primitive leaf cell instances.
`List<EDIFHierCellInst>`	`getAllLeafDescendants(EDIFHierCellInst instance)` Searches all lower levels of hierarchy to find all leaf descendants.
`List<EDIFHierCellInst>`	`getAllLeafDescendants(EDIFHierCellInst instance, boolean includeBlackBoxes)` Searches all lower levels of hierarchy to find all leaf descendants.
`List<EDIFHierCellInst>`	`getAllLeafDescendants(String instanceName)` Searches all lower levels of hierarchy to find all leaf descendants.
`List<EDIFHierCellInst>`	`getAllLeafDescendants(String instanceName, String wildcardPattern)`
`List<EDIFHierCellInst>`	`getAllLeafHierCellInstances()` Traverses the netlist and produces a list of all primitive leaf hierarchical cell instances.
`List<EDIFHierCellInst>`	`getAllLeafHierCellInstances(boolean includeBlackBoxes)` Traverses the netlist and produces a list of all primitive leaf hierarchical cell instances.
`EDIFCell`	`getCell(String legalEdifName)` Iterates through libraries to find first cell with matching name and returns it.
`EDIFCellInst`	`getCellInstFromHierName(String name)` Based on a hierarchical string, this method will get the instance corresponding to the name provided.
`List<String>`	`getComments()`
`EDIFDesign`	`getDesign()`
`Device`	`getDevice()`
`List<String>`	`getEncryptedCells()` Gets the list of EDN filenames that were present in the original directory where the EDIF file was loaded from.
`EDIFCell`	`getHDIPrimitive(Unisim unisim)` Will create or get the specified unisim cell and ensure it is added to the HDI primitives library.
`EDIFLibrary`	`getHDIPrimitivesLibrary()`
`EDIFHierCellInst`	`getHierCellInstFromName(String name)` Creates a new hierarchical cell instance reference from the provided hierarchical cell instance name
`EDIFHierNet`	`getHierNetFromName(String netName)` Gets the hierarchical net from the netname provided.
`Pair<List<EDIFCellInst>,String>`	`getHierObject(String name)` Resolve as much of a hierarchical name as possible to a List of EDIFCellInsts, suitable for creating a EDIFHierCellInst from.
`EDIFHierPortInst`	`getHierPortInstFromName(String hierPortInstName)` Gets the hierarchical port instance object from the full name.
`Collection<EDIFPropertyValue>`	`getIOStandards(EDIFCellInst eci)` Helper method to get the set of IOStandard properties of an EDIFCellInst; should one not exist, fallback to the IOStandard property on the EDIFNet object(s) connected to the top-level output port(s) that it drives.
`Collection<EDIFLibrary>`	`getLibraries()`
`List<EDIFLibrary>`	`getLibrariesInExportOrder()` Get Libraries in export order so that any cell instance appearing in a library will only refer to cells in its own library or previous libraries in the list.
`Map<String,EDIFLibrary>`	`getLibrariesMap()`
`EDIFLibrary`	`getLibrary(String name)`
`Map<EDIFCell,List<EDIFChange>>`	`getModifiedCells()`
`List<EDIFHierNet>`	`getNetAliases(EDIFHierNet initialNet)` Get's all equivalent nets in the netlist from the provided net name.
`EDIFNet`	`getNetFromHierName(String netName)` Based on a hierarchical string name, this method gets and returns the net inside the instance.
`String`	`getOrigDirectory()` Keeps track of the original source directory from where this EDIF file was loaded.
`EDIFHierNet`	`getParentNet(EDIFHierNet netAlias)` Gets the canonical net for this net name.
`Map<EDIFHierNet,EDIFHierNet>`	`getParentNetMap()` Gets the map of all canonical net for every net alias.
`Map<String,String>`	`getParentNetMapNames()` Gets the map of all canonical net for every net alias.
`String`	`getParentNetName(String netAlias)` Gets the canonical net for this net name.
`List<EDIFHierPortInst>`	`getPhysicalGndPins()` Get all Physical ground pins
`Net`	`getPhysicalNetFromPin(EDIFHierPortInst p, Design d)`
`Net`	`getPhysicalNetFromPin(String parentHierInstName, EDIFPortInst p, Design d)`
`Map<EDIFHierNet,List<EDIFHierPortInst>>`	`getPhysicalNetPinMap()` Get the physical pins all parent nets (as returned by `EDIFNetlist.getParentNet(EDIFHierNet)`).
`List<EDIFHierPortInst>`	`getPhysicalPins(EDIFHierNet parentNet)` Get the physical pins of this net.
`List<EDIFHierPortInst>`	`getPhysicalPins(Net net)` For a given physical net, get all physical pins from the EDIF.
`List<EDIFHierPortInst>`	`getPhysicalPins(String parentNetName)` Get all physical pins of a net.
`List<EDIFHierPortInst>`	`getPhysicalVccPins()` Get all Physical vcc pins
`List<EDIFHierPortInst>`	`getSinksFromNet(EDIFHierNet net)` Gets all the primitive pin sinks that are strict descendants of this provided net.
`EDIFCell`	`getTopCell()`
`EDIFCellInst`	`getTopCellInst()`
`EDIFHierCellInst`	`getTopHierCellInst()`
`static List<EDIFCell>`	`getValidCellExportOrder(Set<EDIFCell> cells, boolean stable)` Creates an ordered list of cells such that each cell that appears in the list only references cells that have already been seen in the list.
`EDIFLibrary`	`getWorkLibrary()`
`static NetType`	`identifyNetType(EDIFHierPortInst source)`
`boolean`	`isTrackingCellChanges()` Checks a flag indicating if this netlist is currently tracking changes to its EDIFCells.
`static void`	`main(String[] args)`
`void`	`migrateCellAndSubCells(EDIFCell cell)` This moves the cell and all of its descendants into this netlist.
`void`	`migrateCellAndSubCells(EDIFCell cell, boolean uniqueifyCollisions)`
`void`	`migrateToWorkLibrary(String library)` Migrates all cells in the provided library into the standard work library.
`static EDIFNetlist`	`readBinaryEDIF(Path path)`
`static EDIFNetlist`	`readBinaryEDIF(String fileName)`
`EDIFLibrary`	`removeLibrary(String name)`
`void`	`removeUnusedCellsFromAllWorkLibraries()` Removals all unused cells from a netlist from any work library (all except hdi_primitives)
`void`	`removeUnusedCellsFromWorkLibrary()`
`void`	`renameNetlistAndTopCell(String newName)`
`void`	`resetCellInstIOStandardFallbackMap()` Reset the fallback map used by `EDIFNetlist.getIOStandards(com.xilinx.rapidwright.edif.EDIFCellInst)` so that it may be re-initialized upon next use.
`void`	`resetParentNetMap()` Resets the internal parent net map of the netlist.
`void`	`setDesign(EDIFDesign design)`
`void`	`setDevice(Device device)`
`void`	`setEncryptedCells(List<String> encryptedCells)`
`void`	`setTrackCellChanges(boolean trackCellChanges)` Flag to track changes to EDIFCell changes to this netlist.
`void`	`trackChange(EDIFCell cell, EDIFChangeType type, String objectName)`
`void`	`writeBinaryEDIF(OutputStream os)`
`void`	`writeBinaryEDIF(Path path)`
`void`	`writeBinaryEDIF(String fileName)`

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName
compareTo, equals, exportEDIFName, exportSomeEDIFName, getName, getNewMap, hashCode, toString

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

- Field Detail
  - macroExpandExceptionMap
```
public static final Map<Series,Map<String,Pair<String,EnumSet<IOStandard>>>> macroExpandExceptionMap
```
    Map that stores prim to macro expansions conditional based on IOStandards (Start Prim to End Macro (if set IOStandard is in set))
  - macroCollapseExceptionMap
```
public static final Map<Series,Map<String,Pair<String,EnumSet<IOStandard>>>> macroCollapseExceptionMap
```
    Reverse map that stores macro to prim collapse conditional based on IOStandards (Macro to Prim (if set IOStandard is in set))
  - IOSTANDARD_PROP
```
public static final String IOSTANDARD_PROP
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROP_VALUE
```
public static final EDIFPropertyValue DEFAULT_PROP_VALUE
```
  - EXPORT_CONST_EDIF_VERSION
```
public static final byte[] EXPORT_CONST_EDIF_VERSION
```
  - EXPORT_CONST_EDIF_HEAD
```
public static final byte[] EXPORT_CONST_EDIF_HEAD
```
  - EXPORT_CONST_PROGRAM
```
public static final byte[] EXPORT_CONST_PROGRAM
```
  - EXPORT_CONST_CLOSE_NL
```
public static final byte[] EXPORT_CONST_CLOSE_NL
```
  - EXPORT_CONST_QUOTE_CLOSE_NL
```
public static final byte[] EXPORT_CONST_QUOTE_CLOSE_NL
```
  - EXPORT_CONST_COMMENT
```
public static final byte[] EXPORT_CONST_COMMENT
```
  - EXPORT_CONST_META_X
```
public static final byte[] EXPORT_CONST_META_X
```
  - EXPORT_CONST_DOUBLE_CLOSE
```
public static final byte[] EXPORT_CONST_DOUBLE_CLOSE
```
  - EXPORT_CONST_DESIGN_START
```
public static final byte[] EXPORT_CONST_DESIGN_START
```
  - EXPORT_CONST_CELLREF
```
public static final byte[] EXPORT_CONST_CELLREF
```
  - EXPORT_CONST_LIBRARYREF
```
public static final byte[] EXPORT_CONST_LIBRARYREF
```
  - EXPORT_CONST_CLOSE_REF
```
public static final byte[] EXPORT_CONST_CLOSE_REF
```
  - EXPORT_CONST_PROP_INDENT
```
public static final byte[] EXPORT_CONST_PROP_INDENT
```
  - EXPORT_CONST_CLOSE_DESIGN
```
public static final byte[] EXPORT_CONST_CLOSE_DESIGN
```
  - EXPORT_CONST_CLOSE_EDIF
```
public static final byte[] EXPORT_CONST_CLOSE_EDIF
```
  - READ_EDIF_CMD
```
public static final String READ_EDIF_CMD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EDIFNetlist
```
public EDIFNetlist(String name)
```
- Method Detail
  - getValidCellExportOrder
```
public static List<EDIFCell> getValidCellExportOrder(Set<EDIFCell> cells,
                                                     boolean stable)
```
    Creates an ordered list of cells such that each cell that appears in the list only references cells that have already been seen in the list. This is a requirement when exporting the EDIF to a file.
    
    Parameters:
    
    cells - A set of cells to consider.
    
    stable - makes sure that the list is always the same for the same input
    
    Returns:
    
    The ordered list.
  - generateBuildComments
```
public void generateBuildComments()
```
    Adds date and username build comments such as: (comment "Built on 'Mon May 1 15:17:36 PDT 2017'") (comment "Built by 'clavin'")
  - addLibrary
```
public EDIFLibrary addLibrary(EDIFLibrary library)
```
    Adds the library to this netlist. Checks for naming collisions and throws a RuntimeException if it occurs.
    
    Parameters:
    
    library - The library to add.
    
    Returns:
    
    The library that was added.
  - getLibrary
```
public EDIFLibrary getLibrary(String name)
```
  - getHDIPrimitivesLibrary
```
public EDIFLibrary getHDIPrimitivesLibrary()
```
  - getHDIPrimitive
```
public EDIFCell getHDIPrimitive(Unisim unisim)
```
    Will create or get the specified unisim cell and ensure it is added to the HDI primitives library. If the cell is already in the library, it will simply get it and return it.
    
    Parameters:
    
    unisim - The desired Unisim cell type.
    
    Returns:
    
    The current unisim cell in the HDI primitive library for this netlist.
  - getWorkLibrary
```
public EDIFLibrary getWorkLibrary()
```
  - removeLibrary
```
public EDIFLibrary removeLibrary(String name)
```
  - renameNetlistAndTopCell
```
public void renameNetlistAndTopCell(String newName)
```
  - removeUnusedCellsFromAllWorkLibraries
```
public void removeUnusedCellsFromAllWorkLibraries()
```
    Removals all unused cells from a netlist from any work library (all except hdi_primitives)
  - removeUnusedCellsFromWorkLibrary
```
public void removeUnusedCellsFromWorkLibrary()
```
  - getCell
```
public EDIFCell getCell(String legalEdifName)
```
    Iterates through libraries to find first cell with matching name and returns it.
    
    Parameters:
    
    legalEdifName - The legal EDIF name of the cell to find.
    
    Returns:
    
    The first occurring cell with the provided name.
  - getDesign
```
public EDIFDesign getDesign()
```
    Returns:
    
    the design
  - setDesign
```
public void setDesign(EDIFDesign design)
```
    Parameters:
    
    design - the design to set
  - getDevice
```
public Device getDevice()
```
  - setDevice
```
public void setDevice(Device device)
```
  - getTopCell
```
public EDIFCell getTopCell()
```
  - getTopCellInst
```
public EDIFCellInst getTopCellInst()
```
  - getTopHierCellInst
```
public EDIFHierCellInst getTopHierCellInst()
```
  - addComment
```
public boolean addComment(String comment)
```
  - addMetax
```
public EDIFPropertyValue addMetax(String key,
                                  EDIFPropertyValue value)
```
  - getComments
```
public List<String> getComments()
```
    Returns:
    
    the comments
  - migrateToWorkLibrary
```
public void migrateToWorkLibrary(String library)
```
    Migrates all cells in the provided library into the standard work library.
    
    Parameters:
    
    library - The library with cells to be migrated to work.
  - consolidateAllToWorkLibrary
```
public void consolidateAllToWorkLibrary()
```
    Migrates all libraries except HDI primitives and work to the work library.
  - migrateCellAndSubCells
```
public void migrateCellAndSubCells(EDIFCell cell)
```
    This moves the cell and all of its descendants into this netlist. This is a destructive operation for the source netlist.
    
    Parameters:
    
    cell - The cell (and all its descendants) to move into this netlist's libraries
  - migrateCellAndSubCells
```
public void migrateCellAndSubCells(EDIFCell cell,
                                   boolean uniqueifyCollisions)
```
  - copyCellAndSubCells
```
public void copyCellAndSubCells(EDIFCell cell)
```
    This copies the cell and all of its descendants into this netlist.
    
    Parameters:
    
    cell - The cell (and all its descendants) to copy into this netlist's libraries
  - copyLibraryAndSubCells
```
public EDIFLibrary copyLibraryAndSubCells(EDIFLibrary library)
```
    This copies the library and all of its cells into this netlist.
    
    Parameters:
    
    library - The library (and all its cells) to copy into this netlist's libraries
  - changeTopName
```
public void changeTopName(String newName)
```
    Will change the netlist name and top cell and instance name.
    
    Parameters:
    
    newName - New name for the netlist
  - getLibrariesMap
```
public Map<String,EDIFLibrary> getLibrariesMap()
```
    Returns:
    
    the libraries
  - getLibraries
```
public Collection<EDIFLibrary> getLibraries()
```
  - getLibrariesInExportOrder
```
public List<EDIFLibrary> getLibrariesInExportOrder()
```
    Get Libraries in export order so that any cell instance appearing in a library will only refer to cells in its own library or previous libraries in the list. This is a pre-requisite for export to a file.
    
    Returns:
    
    List of all libraries in the netlist sorted for valid export, HDIPrimitives library is always first.
  - exportEDIF
```
public void exportEDIF(OutputStream out,
                       boolean stable)
                throws IOException
```
    Throws:
    
    IOException
  - exportEDIF
```
public void exportEDIF(OutputStream out)
                throws IOException
```
    Throws:
    
    IOException
  - exportEDIF
```
public void exportEDIF(Path fileName,
                       boolean stable)
```
  - exportEDIF
```
public void exportEDIF(Path fileName)
```
  - exportEDIF
```
public void exportEDIF(String fileName)
```
  - getCellInstFromHierName
```
public EDIFCellInst getCellInstFromHierName(String name)
```
    Based on a hierarchical string, this method will get the instance corresponding to the name provided. If more hierarchy information is needed, consider using EDIFNetlist.getHierCellInstFromName(String) instead.
    
    Parameters:
    
    name - Hierarchical name of the instance, for example: 'clk_wiz/inst/bufg0'
    
    Returns:
    
    The instance corresponding to the provided name. If the name string is empty, it returns the top cell instance.
  - getNetFromHierName
```
public EDIFNet getNetFromHierName(String netName)
```
    Based on a hierarchical string name, this method gets and returns the net inside the instance.
    
    Parameters:
    
    netName - The hierarchical name of the net to get, for example: 'inst0/inst1/inst2/net0'
    
    Returns:
    
    The hierarchical net, or null if none could be found.
  - getHierPortInstFromName
```
public EDIFHierPortInst getHierPortInstFromName(String hierPortInstName)
```
    Gets the hierarchical port instance object from the full name.
    
    Parameters:
    
    hierPortInstName - Full hierarchical name of the port instance.
    
    Returns:
    
    The port instance of interest or null if none could be found.
  - getHierObject
```
public Pair<List<EDIFCellInst>,String> getHierObject(String name)
```
    Resolve as much of a hierarchical name as possible to a List of EDIFCellInsts, suitable for creating a EDIFHierCellInst from. Also return the unmatched portion
    
    Parameters:
    
    name - the hierarchical name
    
    Returns:
    
    A pair of EdifHierCellInst and the unmatched portion of the name. The name may be null if we found a complete match
  - getHierCellInstFromName
```
public EDIFHierCellInst getHierCellInstFromName(String name)
```
    Creates a new hierarchical cell instance reference from the provided hierarchical cell instance name
    
    Parameters:
    
    name - Full hierarchical cell instance name
    
    Returns:
    
    Hierarchical cell instance reference or null if named instance could not be found
  - getHierNetFromName
```
public EDIFHierNet getHierNetFromName(String netName)
```
    Gets the hierarchical net from the netname provided. Returns the wrapped EDIFNet, with the hierarchical String in EDIFHierNet.
    
    Parameters:
    
    netName - Full hierarchical name of the net to retrieve.
    
    Returns:
    
    The absolute net with hierarchical name, or null if none could be found.
  - getPhysicalNetFromPin
```
public Net getPhysicalNetFromPin(String parentHierInstName,
                                 EDIFPortInst p,
                                 Design d)
```
  - getPhysicalNetFromPin
```
public Net getPhysicalNetFromPin(EDIFHierPortInst p,
                                 Design d)
```
  - findCellInsts
```
public List<EDIFHierCellInst> findCellInsts(String wildcardPattern)
```
    Searches all EDIFCellInst objects to find those with matching names against the wildcard pattern.
    
    Parameters:
    
    wildcardPattern - Search pattern that includes alphanumeric and wildcards (*).
    
    Returns:
    
    The list of all matching EDIFHierCellInst
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants(String instanceName)
```
    Searches all lower levels of hierarchy to find all leaf descendants. It returns a list of all leaf cells that fall under the hierarchy of the provided instance name.
    
    Parameters:
    
    instanceName - Name of the instance to start searching from.
    
    Returns:
    
    A list of all leaf cell instances or null if the instanceName was not found.
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants(EDIFHierCellInst instance)
```
    Searches all lower levels of hierarchy to find all leaf descendants. It returns a list of all leaf cells that fall under the hierarchy of the provided instance name.
    
    Parameters:
    
    instance - The instance to start searching from.
    
    Returns:
    
    A list of all leaf cell instances or null if the instanceName was not found.
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants(EDIFHierCellInst instance,
                                                    boolean includeBlackBoxes)
```
    Searches all lower levels of hierarchy to find all leaf descendants. It returns a list of all leaf cells that fall under the hierarchy of the provided instance name.
    
    Parameters:
    
    instance - The instance to start searching from.
    
    includeBlackBoxes - Flag, if set to true, will include black box instances in the returned list.
    
    Returns:
    
    A list of all leaf cell instances or null if the instanceName was not found.
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants(String instanceName,
                                                    String wildcardPattern)
```
  - getAllDescendants
```
public List<EDIFHierCellInst> getAllDescendants(String instanceName,
                                                String wildcardPattern,
                                                boolean leavesOnly)
```
    Searches all lower levels of hierarchy to find descendants. It returns the set of all cells that fall under the hierarchy of the provided instance name.
    
    Parameters:
    
    instanceName - Name of the instance to start searching from.
    
    wildcardPattern - if non-null, filters results by matching wildcard pattern
    
    leavesOnly - Flag indicating if only leaf cells should be included
    
    Returns:
    
    A set of all leaf cell instances or null if the instanceName was not found.
  - identifyNetType
```
public static NetType identifyNetType(EDIFHierPortInst source)
```
  - getNetAliases
```
public List<EDIFHierNet> getNetAliases(EDIFHierNet initialNet)
```
    Get's all equivalent nets in the netlist from the provided net name. The returned list also includes the provided netName.
    
    Parameters:
    
    initialNet - Full hierarchical netname to use as a starting point in the search.
    
    Returns:
    
    A list of all electrically connected nets in the netlist that are equivalent. The list is composed of all full hierarchical net names or an empty list if netName is invalid.
  - getParentNetName
```
public String getParentNetName(String netAlias)
```
    Gets the canonical net for this net name. This corresponds to the driving net in the netlist and/or the physical net name.
    
    Parameters:
    
    netAlias - An absolute net name alias (from logical netlist)
    
    Returns:
    
    The physical/parent net name or null if none could be found.
  - getParentNet
```
public EDIFHierNet getParentNet(EDIFHierNet netAlias)
```
    Gets the canonical net for this net name. This corresponds to the driving net in the netlist and/or the physical net name.
    
    Parameters:
    
    netAlias - An absolute net name alias (from logical netlist)
    
    Returns:
    
    The physical/parent net name or null if none could be found.
  - getParentNetMap
```
public Map<EDIFHierNet,EDIFHierNet> getParentNetMap()
```
    Gets the map of all canonical net for every net alias. This corresponds to the driving net in the netlist and/or the physical net name.
    
    Returns:
    
    the map
  - getParentNetMapNames
```
public Map<String,String> getParentNetMapNames()
```
    Gets the map of all canonical net for every net alias. This corresponds to the driving net in the netlist and/or the physical net name. This is the same as of EDIFNetlist.getParentNetMap(), but converted to Strings.
    
    Returns:
    
    the map
  - resetParentNetMap
```
public void resetParentNetMap()
```
    Resets the internal parent net map of the netlist. This is necessary any time modifications are made to the netlist (add/remove/change cells/nets, removing/adding black boxes, etc).
  - getAllLeafCellInstances
```
public List<EDIFCellInst> getAllLeafCellInstances()
```
    Traverses the netlist and produces a list of all primitive leaf cell instances.
    
    Returns:
    
    A list of all primitive leaf cell instances.
  - getAllLeafHierCellInstances
```
public List<EDIFHierCellInst> getAllLeafHierCellInstances(boolean includeBlackBoxes)
```
    Traverses the netlist and produces a list of all primitive leaf hierarchical cell instances.
    
    Parameters:
    
    includeBlackBoxes - Flag if set to true will also include black boxes in the returned list.
    
    Returns:
    
    A list of all primitive leaf hierarchical cell instances.
  - getAllLeafHierCellInstances
```
public List<EDIFHierCellInst> getAllLeafHierCellInstances()
```
    Traverses the netlist and produces a list of all primitive leaf hierarchical cell instances.
    
    Returns:
    
    A list of all primitive leaf hierarchical cell instances.
  - getPhysicalNetPinMap
```
public Map<EDIFHierNet,List<EDIFHierPortInst>> getPhysicalNetPinMap()
```
    Get the physical pins all parent nets (as returned by EDIFNetlist.getParentNet(EDIFHierNet)). No special handling for static nets is performed. Therefore, only the local connectivity is visible. To see all globally connected static pins, use EDIFNetlist.getPhysicalVccPins() and EDIFNetlist.getPhysicalGndPins().
    
    Returns:
    
    the physicalNetPinMap
  - getPhysicalVccPins
```
public List<EDIFHierPortInst> getPhysicalVccPins()
```
    Get all Physical vcc pins
    
    Returns:
    
    the physical vcc pins
  - getPhysicalGndPins
```
public List<EDIFHierPortInst> getPhysicalGndPins()
```
    Get all Physical ground pins
    
    Returns:
    
    the physical ground pins
  - getPhysicalPins
```
public List<EDIFHierPortInst> getPhysicalPins(EDIFHierNet parentNet)
```
    Get the physical pins of this net. No special handling for static nets is performed. Therefore, only the local connectivity is visible. To see all globally connected static pins, use EDIFNetlist.getPhysicalVccPins() and EDIFNetlist.getPhysicalGndPins().
    
    Parameters:
    
    parentNet - the parent net, as returned by EDIFNetlist.getParentNet(EDIFHierNet)
    
    Returns:
    
    all pins
  - getPhysicalPins
```
public List<EDIFHierPortInst> getPhysicalPins(String parentNetName)
```
    Get all physical pins of a net. If "GLOBAL_LOGIC0" or "GLOBAL_LOGIC1" is passed as net name, all global GND/VCC pins will be returned. If a local name of a static net is passed, only the locally connected Pins will be returned. If you want to call this method for a physical net, use EDIFNetlist.getPhysicalPins(Net) instead.
    
    Parameters:
    
    parentNetName - the net name, as returned by EDIFNetlist.getParentNet(EDIFHierNet)
    
    Returns:
    
    the physical pins
  - getPhysicalPins
```
public List<EDIFHierPortInst> getPhysicalPins(Net net)
```
    For a given physical net, get all physical pins from the EDIF. This is the same as calling EDIFNetlist.getPhysicalPins(String) with the net's name, but this function is faster.
    
    Parameters:
    
    net - the physical net
    
    Returns:
    
    all pins
  - getSinksFromNet
```
public List<EDIFHierPortInst> getSinksFromNet(EDIFHierNet net)
```
    Gets all the primitive pin sinks that are strict descendants of this provided net.
    
    Parameters:
    
    net - The net to trace to its sinks.
    
    Returns:
    
    The list of all sink pins on primitive cells that are descendants of the provided net
  - generateEDIFNetMap
```
public HashMap<String,EDIFNet> generateEDIFNetMap(HashMap<String,EDIFCellInst> cellInstMap)
```
    Parameters:
    
    cellInstMap -
    
    Returns:
  - generateCellInstMap
```
public HashMap<String,EDIFCellInst> generateCellInstMap()
```
    Identify primitive cell instances in EDIF netlist
    
    Returns:
    
    A map of hierarchical names (not including top-level name) to EdifCellInstances that use primitives in the library
  - expandMacroUnisims
```
public void expandMacroUnisims(Series series)
```
    Expands macro primitives into a native-compatible implementation. In Vivado, some non-native unisims are expanded or transformed into one or more native unisims to target the architecture while supporting the functionality of the macro unisim. When writing out EDIF in Vivado, these primitives are collapsed back down to their primitive state. This method compensates for this behavior by expanding the macro primitives. As an example, IBUF => IBUF (IBUFCTRL, IBUF) for UltraScale devices.
    
    Parameters:
    
    series - The architecture series targeted by this netlist.
  - collapseMacroUnisims
```
public void collapseMacroUnisims(Series series)
```
    Collapses any macro primitives back into their primitive state. Performs the opposite of EDIFNetlist.expandMacroUnisims(Series).
    
    Parameters:
    
    series - The architecture series targeted by this netlist.
  - getOrigDirectory
```
public String getOrigDirectory()
```
    Keeps track of the original source directory from where this EDIF file was loaded.
    
    Returns:
    
    Original directory path from where the EDIF file was loaded
  - getEncryptedCells
```
public List<String> getEncryptedCells()
```
    Gets the list of EDN filenames that were present in the original directory where the EDIF file was loaded from. These may be important when loading a netlist/checkpoint back into Vivado.
    
    Returns:
    
    A list of EDN filenames that may populate encrypted cells within the netlist.
  - setEncryptedCells
```
public void setEncryptedCells(List<String> encryptedCells)
```
  - addEncryptedCells
```
public void addEncryptedCells(List<String> encryptedCells)
```
  - addTclLoadEncryptedCells
```
public void addTclLoadEncryptedCells(Path tclPath)
```
    Parses a Tcl load script generated by EDIFTools.writeTclLoadScriptForPartialEncryptedDesigns(EDIFNetlist, Path, String). and appends them to this netlist (useful for when merging designs).
    
    Parameters:
    
    tclPath - Path to the existing Tcl load script for the accompanying DCP file
  - readBinaryEDIF
```
public static EDIFNetlist readBinaryEDIF(Path path)
```
  - readBinaryEDIF
```
public static EDIFNetlist readBinaryEDIF(String fileName)
```
  - writeBinaryEDIF
```
public void writeBinaryEDIF(Path path)
```
  - writeBinaryEDIF
```
public void writeBinaryEDIF(OutputStream os)
```
  - writeBinaryEDIF
```
public void writeBinaryEDIF(String fileName)
```
  - isTrackingCellChanges
```
public boolean isTrackingCellChanges()
```
    Checks a flag indicating if this netlist is currently tracking changes to its EDIFCells. Modified EDIFCells are tracked in a set which can be queried with EDIFNetlist.getModifiedCells(). EDIFCells are determined as modified if one of the following is true: (1) A port was removed, added or modified (2) A net was removed, added or modified (3) An instance was removed, added or modified
    
    Returns:
    
    True if this netlist is tracking EDIFCell changes, false otherwise.
  - setTrackCellChanges
```
public void setTrackCellChanges(boolean trackCellChanges)
```
    Flag to track changes to EDIFCell changes to this netlist. See EDIFNetlist.isTrackingCellChanges()
    
    Parameters:
    
    trackCellChanges - True to enable tracking of EDIFCells, false to stop tracking
  - trackChange
```
public void trackChange(EDIFCell cell,
                        EDIFChangeType type,
                        String objectName)
```
  - addTrackingChange
```
public void addTrackingChange(EDIFCell cell,
                              EDIFChange change)
```
  - getModifiedCells
```
public Map<EDIFCell,List<EDIFChange>> getModifiedCells()
```
  - getIOStandards
```
public Collection<EDIFPropertyValue> getIOStandards(EDIFCellInst eci)
```
    Helper method to get the set of IOStandard properties of an EDIFCellInst; should one not exist, fallback to the IOStandard property on the EDIFNet object(s) connected to the top-level output port(s) that it drives. On the first time a fallback is considered, a map is initialized EDIFNetlist.cellInstIOStandardFallback to speed up future queries. This map will not be updated upon connecting a new EDIFNet nor if a new property was added to the existing EDIFNet --- for this map to be re-initialized use EDIFNetlist.resetCellInstIOStandardFallbackMap().
    
    Parameters:
    
    eci - EDIFCellInst object.
    
    Returns:
    
    Collection of EDIFPropertyValue describing its IOStandard. Returns a one-element collection containing EDIFNetlist.DEFAULT_PROP_VALUE if no value found.
  - resetCellInstIOStandardFallbackMap
```
public void resetCellInstIOStandardFallbackMap()
```
    Reset the fallback map used by EDIFNetlist.getIOStandards(com.xilinx.rapidwright.edif.EDIFCellInst) so that it may be re-initialized upon next use.
  - main
```
public static void main(String[] args)
                 throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException

Class EDIFNetlist

Field Summary

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName

Constructor Summary

Method Summary

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName

Methods inherited from class Object

Field Detail

macroExpandExceptionMap

macroCollapseExceptionMap

IOSTANDARD_PROP

DEFAULT_PROP_VALUE

EXPORT_CONST_EDIF_VERSION

EXPORT_CONST_EDIF_HEAD

EXPORT_CONST_PROGRAM

EXPORT_CONST_CLOSE_NL

EXPORT_CONST_QUOTE_CLOSE_NL

EXPORT_CONST_COMMENT

EXPORT_CONST_META_X

EXPORT_CONST_DOUBLE_CLOSE

EXPORT_CONST_DESIGN_START

EXPORT_CONST_CELLREF

EXPORT_CONST_LIBRARYREF

EXPORT_CONST_CLOSE_REF

EXPORT_CONST_PROP_INDENT

EXPORT_CONST_CLOSE_DESIGN

EXPORT_CONST_CLOSE_EDIF

READ_EDIF_CMD

Constructor Detail

EDIFNetlist

Method Detail

getValidCellExportOrder

generateBuildComments

addLibrary

getLibrary

getHDIPrimitivesLibrary

getHDIPrimitive

getWorkLibrary

removeLibrary

renameNetlistAndTopCell

removeUnusedCellsFromAllWorkLibraries

removeUnusedCellsFromWorkLibrary

getCell

getDesign

setDesign

getDevice

setDevice

getTopCell

getTopCellInst

getTopHierCellInst

addComment

addMetax

getComments

migrateToWorkLibrary

consolidateAllToWorkLibrary

migrateCellAndSubCells

migrateCellAndSubCells

copyCellAndSubCells

copyLibraryAndSubCells

changeTopName

getLibrariesMap

getLibraries

getLibrariesInExportOrder

exportEDIF

exportEDIF

exportEDIF

exportEDIF

exportEDIF

getCellInstFromHierName

getNetFromHierName

getHierPortInstFromName

getHierObject

getHierCellInstFromName

getHierNetFromName

getPhysicalNetFromPin

getPhysicalNetFromPin

findCellInsts

getAllLeafDescendants

getAllLeafDescendants

getAllLeafDescendants