edu.byu.ece.edif.tools.flatten
Interface HierarchyNaming

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicHierarchyNaming

public interface HierarchyNaming
extends java.io.Serializable

An interface for accessing hierarchical instances and nets by their hierarchical names.


Method Summary
 HierarchicalInstance getHierarchicalInstance(HierarchicalInstance head, java.lang.String name)
          Given the head node of a HierarchicalInstance hierarchy and a complete hierarchical instance name, get the corresponding HierarchicalInstance node.
 java.lang.String getHierarchicalInstanceName(HierarchicalInstance node)
          Given a HierarchicalInstance node, get it's complete hierarchical name.
 HierarchicalNet getHierarchicalNet(HierarchicalInstance head, java.lang.String name)
          Given the head node of a HierarchicalInstance hierachy and a complete hierarchical net name, get the corresponding HierarchicalNet.
 java.lang.String getHierarchicalNetName(HierarchicalNet hierarchicalNet)
          Given a HierarchicalNet, get it's complete hierarchical name.
 

Method Detail

getHierarchicalInstance

HierarchicalInstance getHierarchicalInstance(HierarchicalInstance head,
                                             java.lang.String name)
Given the head node of a HierarchicalInstance hierarchy and a complete hierarchical instance name, get the corresponding HierarchicalInstance node.

Parameters:
head - the head node of the HierarchicalInstance hierarchy
name - the complete hierarchical name of the desired HierarchicalInstance node
Returns:
the HierarchicalInstance node corresponding to the given name

getHierarchicalInstanceName

java.lang.String getHierarchicalInstanceName(HierarchicalInstance node)
Given a HierarchicalInstance node, get it's complete hierarchical name.

Parameters:
node - the HierarchicalInstance node whose name is desired
Returns:
the complete hierarchical name of the HierarchicalInstance node

getHierarchicalNet

HierarchicalNet getHierarchicalNet(HierarchicalInstance head,
                                   java.lang.String name)
Given the head node of a HierarchicalInstance hierachy and a complete hierarchical net name, get the corresponding HierarchicalNet.

Parameters:
head - the head node of the HierarchicalInstance hierarchy
name - the complete hierarchical name of the desired HierarchicalNet
Returns:
the HierarchicalNet corresponding to the given name

getHierarchicalNetName

java.lang.String getHierarchicalNetName(HierarchicalNet hierarchicalNet)
Given a HierarchicalNet, get it's complete hierarchical name.

Parameters:
hierarchicalNet - the HierarchicalNet whose name is desired
Returns:
the complete hierarchical name of the HierarchicalNet