byucc.jhdl.base
Class HelperLibrary

java.lang.Object
  byucc.jhdl.base.HelperLibrary

public class HelperLibrary

extends java.lang.Object

Constructor Summary

HelperLibrary()

Method Summary

static void	addPropertyToTopWire(Wire w, java.lang.String s, java.lang.Object o) Gets the highest wire (hierarchically) associated with this wire
static java.util.HashMap	createVPtoWiresMapping(Cell top) Creates a HashMap object whose Keys are ValuePropagater Objects, and whose Values are ArrayList Objects of Wires.
static int	getFanoutCount(Wire wire)
static int	getFanoutCount(Wire wire, boolean countFMAP) Returns the number of sink ports that stem off of this wire.
static java.lang.Object	getPropertyFromTopWire(Wire w, java.lang.String s) Gets the highest wire (hierarchically) associated with this wire
static Cell	getTopCell(Wire w)
static Wire	getTopWire(Wire w)
static java.util.ArrayList	getWiresAttachedToVP(Wire wire, java.util.HashMap map)
static boolean	isInnerWire(Wire wire, Cell cell) Determines if this is an inner wire in the context of the passed in cell.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelperLibrary

public HelperLibrary()

Method Detail

isInnerWire

public static boolean isInnerWire(Wire wire,
                                  Cell cell)

Determines if this is an inner wire in the context of the passed in cell. An inner wire, according to this method's definition, is a wire that is not connected to any of the passed-in cell's top level ports.

Returns:

True if this is an inner wire, false if it connects to a top-level port

getFanoutCount

public static int getFanoutCount(Wire wire)

getFanoutCount

public static int getFanoutCount(Wire wire,
                                 boolean countFMAP)

Returns the number of sink ports that stem off of this wire. Should only be used for single bit wires!!!

Parameters:

countFMAP - Paramaterizes whether or not to count fmaps for fanout purposes. This paramater defaults to false if getFanoutCount(Wire) is used.

Returns:

an integer of how many sink ports stem off of this wire

See Also:

getFanoutCount(Wire)

getWiresAttachedToVP

public static java.util.ArrayList getWiresAttachedToVP(Wire wire,
                                                       java.util.HashMap map)

getTopWire

public static Wire getTopWire(Wire w)

getTopCell

public static Cell getTopCell(Wire w)

getPropertyFromTopWire

public static java.lang.Object getPropertyFromTopWire(Wire w,
                                                      java.lang.String s)

Gets the highest wire (hierarchically) associated with this wire

addPropertyToTopWire

public static void addPropertyToTopWire(Wire w,
                                        java.lang.String s,
                                        java.lang.Object o)

Gets the highest wire (hierarchically) associated with this wire

createVPtoWiresMapping

public static java.util.HashMap createVPtoWiresMapping(Cell top)

Creates a HashMap object whose Keys are ValuePropagater Objects, and whose Values are ArrayList Objects of Wires.

Parameters:

top - A Cell that is the top cell of the design