byucc.jhdl.base
Class CL

java.lang.Object
  |
  +--byucc.jhdl.base.Nameable
        |
        +--byucc.jhdl.base.Node
              |
              +--byucc.jhdl.base.Cell
                    |
                    +--byucc.jhdl.base.CL
All Implemented Interfaces:
BooleanFlags, byucc.jhdl.base.Propagateable, TreeListable
Direct Known Subclasses:
and2, and2, and2, and2_dp, and2b1, and2b1, and2b1, and2b2, and2b2, and2b2, and3, and3, and3, and3_dp, and3b1, and3b1, and3b1, and3b2, and3b2, and3b2, and3b3, and3b3, and3b3, and4, and4, and4, and4b1, and4b1, and4b1, and4b2, and4b2, and4b2, and4b3, and4b3, and4b3, and4b4, and4b4, and4b4, bufcf, bufcf, buffclk, bufg, bufge, bufgls, bufgmux, bufgmux_1, bufgs, ClockDriver, ibuf_agp, ibuf_agp, ibuf_ctt, ibuf_ctt, ibuf_gtl, ibuf_gtl, ibuf_gtlp, ibuf_gtlp, ibuf_hstl_i, ibuf_hstl_i, ibuf_hstl_iii, ibuf_hstl_iii, ibuf_hstl_iv, ibuf_hstl_iv, ibuf_lvcmos2, ibuf_lvcmos2, ibuf_pci33_3, ibuf_pci33_3, ibuf_pci33_5, ibuf_pci33_5, ibuf_pci66_3, ibuf_pci66_3, ibuf_sstl2_i, ibuf_sstl2_i, ibuf_sstl2_ii, ibuf_sstl2_ii, ibuf_sstl3_i, ibuf_sstl3_i, ibuf_sstl3_ii, ibuf_sstl3_ii, ibufds, ibufg, ibufg, ibufg_agp, ibufg_agp, ibufg_ctt, ibufg_ctt, ibufg_gtl, ibufg_gtl, ibufg_gtlp, ibufg_gtlp, ibufg_hstl_i, ibufg_hstl_i, ibufg_hstl_iii, ibufg_hstl_iii, ibufg_hstl_iv, ibufg_hstl_iv, ibufg_lvcmos2, ibufg_lvcmos2, ibufg_pci33_3, ibufg_pci33_3, ibufg_pci33_5, ibufg_pci33_5, ibufg_pci66_3, ibufg_pci66_3, ibufg_sstl2_i, ibufg_sstl2_i, ibufg_sstl2_ii, ibufg_sstl2_ii, ibufg_sstl3_i, ibufg_sstl3_i, ibufg_sstl3_ii, ibufg_sstl3_ii, ibufgds, inv, inv, md0, md1, md2, mult_and, mult_and, mult18x18, muxcy, muxcy, muxcy_d, muxcy_d, muxcy_l, muxcy_l, muxf5, muxf5, muxf5_d, muxf5_d, muxf5_l, muxf5_l, muxf6, muxf6, muxf6_d, muxf6_d, muxf6_l, muxf6_l, muxf7, muxf7_d, muxf7_l, muxf8, muxf8_d, muxf8_l, nand2, nand2, nand2, nand2_dp, nand2b1, nand2b1, nand2b1, nand2b2, nand2b2, nand2b2, nand3, nand3, nand3, nand3_dp, nand3b1, nand3b1, nand3b1, nand3b2, nand3b2, nand3b2, nand3b3, nand3b3, nand3b3, nand4, nand4, nand4, nand4b1, nand4b1, nand4b1, nand4b2, nand4b2, nand4b2, nand4b3, nand4b3, nand4b3, nand4b4, nand4b4, nand4b4, nor2, nor2, nor2, nor2_dp, nor2b1, nor2b1, nor2b1, nor2b2, nor2b2, nor2b2, nor3, nor3, nor3, nor3_dp, nor3b1, nor3b1, nor3b1, nor3b2, nor3b2, nor3b2, nor3b3, nor3b3, nor3b3, nor4, nor4, nor4, nor4b1, nor4b1, nor4b1, nor4b2, nor4b2, nor4b2, nor4b3, nor4b3, nor4b3, nor4b4, nor4b4, nor4b4, oand2, obuf_agp, obuf_agp, obuf_ctt, obuf_ctt, obuf_f_12, obuf_f_12, obuf_f_16, obuf_f_16, obuf_f_2, obuf_f_2, obuf_f_24, obuf_f_24, obuf_f_4, obuf_f_4, obuf_f_6, obuf_f_6, obuf_f_8, obuf_f_8, obuf_gtl, obuf_gtl, obuf_gtlp, obuf_gtlp, obuf_hstl_i, obuf_hstl_i, obuf_hstl_iii, obuf_hstl_iii, obuf_hstl_iv, obuf_hstl_iv, obuf_lvcmos2, obuf_lvcmos2, obuf_pci33_3, obuf_pci33_3, obuf_pci33_5, obuf_pci33_5, obuf_pci66_3, obuf_pci66_3, obuf_s_12, obuf_s_12, obuf_s_16, obuf_s_16, obuf_s_2, obuf_s_2, obuf_s_24, obuf_s_24, obuf_s_4, obuf_s_4, obuf_s_6, obuf_s_6, obuf_s_8, obuf_s_8, obuf_sstl2_i, obuf_sstl2_i, obuf_sstl2_ii, obuf_sstl2_ii, obuf_sstl3_i, obuf_sstl3_i, obuf_sstl3_ii, obuf_sstl3_ii, obufds, omux2, onand2, onor2, oor2, or2, or2, or2, or2_dp, or2b1, or2b1, or2b1, or2b2, or2b2, or2b2, or3, or3, or3, or3_dp, or3b1, or3b1, or3b1, or3b2, or3b2, or3b2, or3b3, or3b3, or3b3, or4, or4, or4, or4b1, or4b1, or4b1, or4b2, or4b2, or4b2, or4b3, or4b3, or4b3, or4b4, or4b4, or4b4, orcy, oxnor2, oxor2, PullUpDown, SimulationBuffer, SimulationBuffer, SimulationBuffer, tdi, tdo, wand, wor2and, xnor2, xnor2, xnor2, xnor2_dp, xnor3, xnor3, xnor3, xnor3_dp, xnor4, xnor4, xnor4, xor2, xor2, xor2, xor2_dp, xor3, xor3, xor3, xor3_dp, xor4, xor4, xor4, xorcy, xorcy, xorcy_d, xorcy_d, xorcy_l, xorcy_l

public abstract class CL
extends Cell
implements byucc.jhdl.base.Propagateable

This can be used as a super-class for a cell that is purely combinational.

Author:
Brad Hutchings

Fields inherited from class byucc.jhdl.base.Cell
BOOLEAN, CELL_NAME_DECLARATION, CellInterfaceDeterminesUniqueNetlistStructure, DETERMINE_FROM_STRING, GENERICS_DECLARATION, implicit_interface, IMPLICIT_INTERFACE_DECLARATION, INTEGER, INTERFACE_DECLARATION, LONG, PORT_IOS_DECLARATION, PORT_NAMES_DECLARATION, PORT_NET_NAMES_DECLARATION, PORT_PROPERTIES, PORT_WIDTHS_DECLARATION, SIGN_EXT, STRING, ZERO_PAD
 
Fields inherited from interface byucc.jhdl.base.BooleanFlags
ANTECEDANT_IS_BEHAVIORALLY_MODELED, ASYNC_PORT, ASYNCHRONOUS_RESOLVED, ATOMICALLY_PLACEABLE, ATOMICALLY_UNMAPPABLE, BEHAVIORALLY_MODELED_BRANCH, CLK_PORT, CLOCK_METHOD_IMPLEMENTED_BY_USER, CLOCK_METHOD_IS_DISABLED, CLOCKABLE_IS_SCHEDULED, DANGLING_IS_OK, DELETE_MARK, FATAL_BUILD_ERROR_OCCURED, HAS_BEEN_TRACED, HAS_USER_SPECIFIED_NAME, HWUPDATE, IMPLICIT_PORT, IN_CLK_PORT, IN_PORT, INOUT_PORT, IO_TYPE_FLAGS, IS_BEHAVIORALLY_MODELED, IS_ON_BUILD_STACK, IS_ON_PROP_LIST, IS_PLACED, METHODS_IMPLEMENTED_BY_USER, NETLISTABLE, ORIG_WIRE_IS_ATOMIC, OUT_PORT, PLACEMENT_IS_LOCKED, PROPAGATE_METHOD_IMPLEMENTED_BY_USER, PROPAGATE_METHOD_IS_DISABLED, RECURSION_FLAG, RESET_METHOD_IMPLEMENTED_BY_USER, SIMULATEABLE, SOURCELESS_IS_OK, SYNC_PORT, VISIBLE
 
Constructor Summary
CL(Node parent)
          Basic constructor for a CL node that takes a parent.
CL(Node parent, java.lang.String name)
          Basic constructor for a CL node that takes a parent and a name.
 
Method Summary
protected  boolean defaultSimulationModelIsBehavioral()
          Whether the cell should be simulated behaviorally
 boolean hasBeenTraced()
          Used to mark if something has been traced, to avoid infinite tracing loops.
 boolean hasBeenTraced(boolean flag)
          Used to set whether something has been traced, to avoid infinite tracing loops.
 boolean hasBehaviorInClockMethod()
          A CL cell is never behaviorally clocked
 boolean hasBehaviorInPropagateMethod()
          A CL cell always has a behavioral propagate method
 boolean isAsynchronouslyScheduled()
          The levelized simulator uses this to keep track of what has been levelized (put on the propagate list thus far.
 boolean isAsynchronouslyScheduled(boolean is_scheduled)
          Used to mark something as put on the propagate list.
 boolean isReadyToBeAsynchronouslyScheduled()
          A CL node is ready to put on the list when all of its input wires are marked (on the Propagate list), or if it is not being behaviorally modeled.
 boolean needsToBeAsynchronouslyScheduled()
          CL nodes must always be propagated unless global behavioral modeling is disabled.
 void propagate()
          Used for things that are combinationally propagated like combinational logic and Wires and such.
 
Methods inherited from class byucc.jhdl.base.Cell
addPort, addPorts, addProperties, addProperties, addProperty, addProperty, antecedantIsBehaviorallyModeled, antecedantIsBehaviorallyModeled, bind, bind, bind, bind, cellInterfaceDeterminesUniqueNetlistStructure, clk, connect, connectAllWires, connectOptional, constructSubCell, constructSubCellNoImplicitPorts, disableAllBehavioralModels, disableBehavioralModel, enableBehavioralModel, getArgument, getAttachedPort, getAttachedWire, getCellName, getCellNetlist, getCellNetList, getCellNetlist, getDescendents, getFlatNetlist, getFlatNetlistableChildren, getGeneric, getHeight, getNetlistableChildren, getPlacementInfo, getPortProperties, getPortRecord, getPortRecords, getProperties, getSinkWires, getSourceWires, getSubCellClass, getUniqueCellName, getWidth, getX, getY, hasPort, hasPorts, in, in, inout, inout, isAsynchronousSourceSinkResolved, isBehaviorallyModeled, isBehaviorallyModeledBranch, isInput, isLeafCell, isNetlistable, isNetlistable, isNetlistablePort, isNetlistLeaf, isNotNetlistable, isNotNetlistablePort, isNotVisible, isOutput, isPlaceable, isPlaceable, isPlaced, isPlaced, isPlacementLocked, isRoot, isSimulateable, isSimulateable, isSink, isSource, isVisible, isVisible, join, lockPlacement, nc, out, out, param, popHierarchy, port, port, port, postorderCheck, preorderCheck, pushHierarchy, pushHierarchy, pushHierarchy, pushHierarchy, pushHierarchyNoImplicitPorts, pushHierarchyNoImplicitPorts, removePort, removeProperty, replaceProperty, replaceProperty, resetBehavioralModelsToDefaults, setAsynchronousSourceSinkResolved, setGeneric, setHeight, setNotNetlistable, setNotNetlistable, setNotVisible, setNotVisible, setPlacementInfo, setPortNotNetlistable, setPortNotNetlistable, setWidth, subClassDelete, toString, uniquifyCell, userDefinedClockCount, verifyAndCleanup
 
Methods inherited from class byucc.jhdl.base.Node
addObservable, addSimulatorCallback, checkAll, delete, getBuildingFlag, getChildren, getChildrenEnumeration, getDefaultClock, getInstanceName, getParent, getParentCell, getRelatives, getSystem, getWires, optimize, orphanAllowed, printAllChildren, printTree, removeSimulatorCallback, setDefaultClock
 
Methods inherited from class byucc.jhdl.base.Nameable
caseSensitivity, caseSensitivity, disableNameClashChecking, getFullName, getFullNameNoTestBench, getHierNameNoTestBench, getInstanceNo, getInstanceNumber, getLeafName, getLeafName, getRelativeName, getUserName, getUserName, hasUserSpecifiedName, isDescendantOf, setInstanceNumber
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CL

public CL(Node parent,
          java.lang.String name)
Basic constructor for a CL node that takes a parent and a name. In the default, the simulation model for a CL node is enabled unless an antecedant is being modeled.
Parameters:
parent - your parent.
name - your name.

CL

public CL(Node parent)
Basic constructor for a CL node that takes a parent.
Parameters:
parent - your parent.
Method Detail

isReadyToBeAsynchronouslyScheduled

public boolean isReadyToBeAsynchronouslyScheduled()
A CL node is ready to put on the list when all of its input wires are marked (on the Propagate list), or if it is not being behaviorally modeled.
Specified by:
isReadyToBeAsynchronouslyScheduled in interface byucc.jhdl.base.Propagateable
Returns:
true if ready to go on the list, false otherwise.

needsToBeAsynchronouslyScheduled

public boolean needsToBeAsynchronouslyScheduled()
CL nodes must always be propagated unless global behavioral modeling is disabled.
Specified by:
needsToBeAsynchronouslyScheduled in interface byucc.jhdl.base.Propagateable
Overrides:
needsToBeAsynchronouslyScheduled in class Cell
Returns:
true if it needs to be propagated, false otherwise.

defaultSimulationModelIsBehavioral

protected boolean defaultSimulationModelIsBehavioral()
Whether the cell should be simulated behaviorally
Overrides:
defaultSimulationModelIsBehavioral in class Cell
Returns:
true by default

hasBehaviorInClockMethod

public final boolean hasBehaviorInClockMethod()
A CL cell is never behaviorally clocked
Overrides:
hasBehaviorInClockMethod in class Cell
Returns:
false

hasBehaviorInPropagateMethod

public final boolean hasBehaviorInPropagateMethod()
A CL cell always has a behavioral propagate method
Overrides:
hasBehaviorInPropagateMethod in class Cell
Returns:
true

propagate

public void propagate()
Used for things that are combinationally propagated like combinational logic and Wires and such.

isAsynchronouslyScheduled

public boolean isAsynchronouslyScheduled()
The levelized simulator uses this to keep track of what has been levelized (put on the propagate list thus far.
Returns:
true if it is on the list

isAsynchronouslyScheduled

public boolean isAsynchronouslyScheduled(boolean is_scheduled)
Used to mark something as put on the propagate list.
Parameters:
is_on_list - true if on list, false otherwise.
Returns:
the prior value of the flag

hasBeenTraced

public boolean hasBeenTraced()
Used to mark if something has been traced, to avoid infinite tracing loops.
Returns:
true if has been traced, false otherwise

hasBeenTraced

public boolean hasBeenTraced(boolean flag)
Used to set whether something has been traced, to avoid infinite tracing loops.
Parameters:
flag - value to set flag to
Returns:
the prior value of the flag, useful for caching and restoring