com.xilinx.rapidwright.edif

Class EDIFHierNet

Object

com.xilinx.rapidwright.edif.EDIFHierNet

public class EDIFHierNet
extends Object

Combines an EDIFNet with a full hierarchical instance name to uniquely identify a net in a netlist. Created on: Sep 13, 2017

Constructor Summary

Constructors

Constructor and Description
EDIFHierNet(@NotNull EDIFHierCellInst hierarchicalInst, @NotNull EDIFNet net) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
EDIFHierCellInst	getHierarchicalInst()
String	getHierarchicalInstName()
String	getHierarchicalInstName(EDIFPortInst port) Given a port on the net, gives the full hierarchical name of the instance attached to the port.
String	getHierarchicalNetName()
List<EDIFHierPortInst>	getLeafHierPortInsts() Gets all connected leaf port instances (inputs and outputs, but not inouts) on this hierarchical net and its aliases.
List<EDIFHierPortInst>	getLeafHierPortInsts(boolean includeSourcePins) Gets all connected leaf port instances (inputs, and optionally outputs, but not inouts) on this hierarchical net and its aliases.
List<EDIFHierPortInst>	getLeafHierPortInsts(boolean includeSourcePins, boolean includeSinkPins) Gets all connected leaf port instances (inputs, and/or outputs, but not inouts) on this hierarchical net and its aliases.
List<EDIFHierPortInst>	getLeafHierPortInsts(boolean includeSourcePins, boolean includeSinkPins, Set<EDIFHierNet> visited) Gets all connected leaf port instances (inputs, and/or outputs, but not inouts) on this hierarchical net and its aliases.
List<EDIFHierPortInst>	getLeafHierPortInsts(boolean includeSourcePins, Set<EDIFHierNet> visited) Gets all connected leaf port instances (inputs, and optionally outputs, but not inouts) on this hierarchical net and its aliases.
EDIFNet	getNet()
EDIFCellInst	getParentInst() Gets the parent cell instance where this net is defined.
Collection<EDIFHierPortInst>	getPortInsts() Gets the sorted ArrayList of EDIFHierPortInsts on this net as a collection.
List<EDIFHierPortInst>	getSourcePortInsts(boolean includeTopLevelPorts) This returns all sources on the net, either output ports of the cell instances in the cell or the top level input ports.
int	hashCode()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EDIFHierNet

public EDIFHierNet(@NotNull
                   @NotNull EDIFHierCellInst hierarchicalInst,
                   @NotNull
                   @NotNull EDIFNet net)

Constructor

Parameters:

hierarchicalInst - Parent instance cell that contains this net

net - The actual net object

Method Detail

getHierarchicalInstName

public String getHierarchicalInstName()

Returns:

the hierarchicalInstName

getNet

public EDIFNet getNet()

Returns:

the net

getHierarchicalInstName

public String getHierarchicalInstName(EDIFPortInst port)

Given a port on the net, gives the full hierarchical name of the instance attached to the port.

Parameters:

port - The reference port of the instance.

Returns:

Full hierarchical name of the instance attached to the port.

getHierarchicalNetName

public String getHierarchicalNetName()

getParentInst

public EDIFCellInst getParentInst()

Gets the parent cell instance where this net is defined.

Returns:

The parent cell instance of this net.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getHierarchicalInst

public EDIFHierCellInst getHierarchicalInst()

getPortInsts

public Collection<EDIFHierPortInst> getPortInsts()

Gets the sorted ArrayList of EDIFHierPortInsts on this net as a collection.

Returns:

The collection of EDIFPortInsts on this net.

getSourcePortInsts

public List<EDIFHierPortInst> getSourcePortInsts(boolean includeTopLevelPorts)

This returns all sources on the net, either output ports of the cell instances in the cell or the top level input ports.

Returns:

A list of EDIFHierPortInst sources.

getLeafHierPortInsts

public List<EDIFHierPortInst> getLeafHierPortInsts()

Gets all connected leaf port instances (inputs and outputs, but not inouts) on this hierarchical net and its aliases.

Returns:

The list of all leaf cell port instances connected to this hierarchical net and its aliases.

getLeafHierPortInsts

public List<EDIFHierPortInst> getLeafHierPortInsts(boolean includeSourcePins)

Gets all connected leaf port instances (inputs, and optionally outputs, but not inouts) on this hierarchical net and its aliases.

Parameters:

includeSourcePins - A flag to include source pins in the result. Setting this to false only returns the sinks.

Returns:

The list of all leaf cell port instances connected to this hierarchical net and its aliases.

getLeafHierPortInsts

public List<EDIFHierPortInst> getLeafHierPortInsts(boolean includeSourcePins,
                                                   boolean includeSinkPins)

Gets all connected leaf port instances (inputs, and/or outputs, but not inouts) on this hierarchical net and its aliases. Setting includeSourcePins and includeSinkPins to false will return an empty list.

Parameters:

includeSourcePins - A flag to include source pins in the result.

includeSinkPins - A flag to include sink pins in the result.

Returns:

The list of all leaf cell port instances connected to this hierarchical net and its aliases.

getLeafHierPortInsts

public List<EDIFHierPortInst> getLeafHierPortInsts(boolean includeSourcePins,
                                                   Set<EDIFHierNet> visited)

Gets all connected leaf port instances (inputs, and optionally outputs, but not inouts) on this hierarchical net and its aliases.

Parameters:

includeSourcePins - A flag to include source pins in the result.

visited - An initial set of EDIFHierNet-s that have already been visited and will not be visited again. Pre-populating this set can be useful for blocking traversal.

Returns:

The list of all leaf cell port instances connected to this hierarchical net and its aliases.

getLeafHierPortInsts

public List<EDIFHierPortInst> getLeafHierPortInsts(boolean includeSourcePins,
                                                   boolean includeSinkPins,
                                                   Set<EDIFHierNet> visited)

Gets all connected leaf port instances (inputs, and/or outputs, but not inouts) on this hierarchical net and its aliases. Setting includeSourcePins and includeSinkPins to false will return an empty list.

Parameters:

includeSourcePins - A flag to include source pins in the result.

includeSinkPins - A flag to include sink pins in the result.

visited - An initial set of EDIFHierNet-s that have already been visited and will not be visited again. Pre-populating this set can be useful for blocking traversal.

Returns:

The list of all leaf cell port instances connected to this hierarchical net and its aliases.