EDIFHierCellInst

Object
- com.xilinx.rapidwright.edif.EDIFHierCellInst

```
public class EDIFHierCellInst
extends Object
```
An EDIFCellInst with its hierarchy, described by all the EDIFCellInsts that sit above it within the netlist. Instances of this class do not necessarily describe a complete hierarchy from the top level cell to a leaf instance. They may also be used to describe a partial hierarchy starting at an arbitrary point in the design. Instances of this class are immutable: Once created, it cannot be changed. Created on: Oct 30, 2017

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildren(Collection<EDIFHierCellInst> collection)` Add this instance's children to some collection
`static EDIFHierCellInst`	`create(EDIFCellInst... cellInsts)` Create an absolute EDIFHierCellInst.
`static EDIFHierCellInst`	`createRelative(EDIFCellInst... cellInsts)` Create an EDIFHierCellInst.
`static EDIFHierCellInst`	`createTopInst(EDIFCellInst topCell)`
`boolean`	`enterHierarchicalName(StringBuilder sb)`
`boolean`	`equals(Object o)`
`String`	`getCellName()`
`EDIFCell`	`getCellType()`
`EDIFHierCellInst`	`getChild(EDIFCellInst relativeChild)`
`EDIFHierCellInst`	`getChild(String relativeChildName)` Get a direct child
`EDIFHierCellInst`	`getCommonAncestor(EDIFHierCellInst o)` Given this instance and the provided instance o, it determines the closest common ancestor between the two instances.
`int`	`getDepth()`
`String`	`getFullHierarchicalInstName()`
`List<EDIFCellInst>`	`getFullHierarchy()`
`List<EDIFHierPortInst>`	`getHierPortInsts()` Gets the hierarchical port insts on this cell instance
`EDIFCellInst`	`getInst()`
`EDIFHierNet`	`getNet(String netName)`
`EDIFHierCellInst`	`getParent()`
`EDIFHierPortInst`	`getPortInst(String portName)` Get a hierarchical port inst, viewed from external to this cell inst.
`EDIFHierCellInst`	`getReferenceCopy()` Creates a reference copy of this cell instance--a deep copy of the instance without this new instance being referenced in the design or netlist object.
`EDIFHierCellInst`	`getSibling(EDIFCellInst relativeSibling)`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`boolean`	`isDescendantOf(EDIFHierCellInst potentialAncestor)` Checks if the provided instance is an ancestor (hierarchical parent) of this instance.
`boolean`	`isTopLevelInst()` Checks if this instance is the top level instance of the netlist.
`boolean`	`isUniquified()` True if all cells on this path are the only instantiations of its cell.
`String`	`toString()`

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

- Method Detail
  - create
```
public static EDIFHierCellInst create(EDIFCellInst... cellInsts)
```
    Create an absolute EDIFHierCellInst. The first cellInst is required to be the top cell inst as returned by EDIFNetlist.getTopCellInst()
    
    Parameters:
    
    cellInsts - the hierarchy of cell insts
    
    Returns:
    
    a new instance
  - createTopInst
```
public static EDIFHierCellInst createTopInst(EDIFCellInst topCell)
```
  - createRelative
```
public static EDIFHierCellInst createRelative(EDIFCellInst... cellInsts)
```
    Create an EDIFHierCellInst. This may be absolute (first item is the top cell inst) or relative (starting at an arbitrary point in the hierarchy).
    
    Parameters:
    
    cellInsts - the hierarchy of cell insts
    
    Returns:
    
    a new top instance
  - getInst
```
public EDIFCellInst getInst()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getParent
```
public EDIFHierCellInst getParent()
```
  - getChild
```
public EDIFHierCellInst getChild(EDIFCellInst relativeChild)
```
  - getSibling
```
public EDIFHierCellInst getSibling(EDIFCellInst relativeSibling)
```
  - isDescendantOf
```
public boolean isDescendantOf(EDIFHierCellInst potentialAncestor)
```
    Checks if the provided instance is an ancestor (hierarchical parent) of this instance. For example, if this="disneyland/tomorrow_land/space_mountain" and potentialAncestor="disneyland/tomorrow_land", this method would return true. however, if potentialAncestor="disneyland/adventure_land", it would return false.
    
    Parameters:
    
    potentialAncestor - The hierarchical instance in question to check if it is
    
    Returns:
    
    True if the provided instance is a hierarchical ancestor of this instance.
  - getCommonAncestor
```
public EDIFHierCellInst getCommonAncestor(EDIFHierCellInst o)
```
    Given this instance and the provided instance o, it determines the closest common ancestor between the two instances. In some cases, this can default to the top cell design instance. For example, if this instance = "a/b/c/d" and o = "a/b/e/f", the method would return "a/b".
    
    Parameters:
    
    o - The other instance to check for a common ancestor.
    
    Returns:
    
    The closest common ancestor between this instance and the provided instance.
  - isAbsolute
```
public boolean isAbsolute()
```
  - getFullHierarchy
```
public List<EDIFCellInst> getFullHierarchy()
```
  - getDepth
```
public int getDepth()
```
  - enterHierarchicalName
```
public boolean enterHierarchicalName(StringBuilder sb)
```
  - getFullHierarchicalInstName
```
public String getFullHierarchicalInstName()
```
  - isTopLevelInst
```
public boolean isTopLevelInst()
```
    Checks if this instance is the top level instance of the netlist.
    
    Returns:
    
    True if this is the top instance, false otherwise.
  - getCellType
```
public EDIFCell getCellType()
```
  - getCellName
```
public String getCellName()
```
  - getChild
```
public EDIFHierCellInst getChild(String relativeChildName)
```
    Get a direct child
    
    Parameters:
    
    relativeChildName - the name of the direct child
    
    Returns:
    
    the hierarchical child
  - getNet
```
public EDIFHierNet getNet(String netName)
```
  - getPortInst
```
public EDIFHierPortInst getPortInst(String portName)
```
    Get a hierarchical port inst, viewed from external to this cell inst.
    
    Parameters:
    
    portName - name of the port to get.
    
    Throws:
    
    IllegalStateException - if the port does not exist
  - getHierPortInsts
```
public List<EDIFHierPortInst> getHierPortInsts()
```
    Gets the hierarchical port insts on this cell instance
    
    Returns:
    
    The list of hierarchical port insts corresponding to this cell inst
  - addChildren
```
public void addChildren(Collection<EDIFHierCellInst> collection)
```
    Add this instance's children to some collection
    
    Parameters:
    
    collection - the collection to add to
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getReferenceCopy
```
public EDIFHierCellInst getReferenceCopy()
```
    Creates a reference copy of this cell instance--a deep copy of the instance without this new instance being referenced in the design or netlist object.
    
    Returns:
    
    The newly created reference copy of this instance.
  - isUniquified
```
public boolean isUniquified()
```
    True if all cells on this path are the only instantiations of its cell.

Class EDIFHierCellInst

Method Summary

Methods inherited from class Object

Method Detail

create

createTopInst

createRelative

getInst

equals

hashCode

getParent

getChild

getSibling

isDescendantOf

getCommonAncestor

isAbsolute

getFullHierarchy

getDepth

enterHierarchicalName

getFullHierarchicalInstName

isTopLevelInst

getCellType

getCellName

getChild

getNet

getPortInst

getHierPortInsts

addChildren

toString

getReferenceCopy

isUniquified