byucc.jhdl.base
Class VisibleAnnotation

java.lang.Object
  byucc.jhdl.base.Nameable
      byucc.jhdl.base.Node
          byucc.jhdl.base.Cell
              byucc.jhdl.base.VisibleAnnotation

All Implemented Interfaces:

BooleanFlags, TreeListable

Direct Known Subclasses:

bscan, bscan_virtex, capture_virtex, capture_virtex2, iopad, iopad, iopad, iopad, ipad, ipad, ipad, ipad, opad, opad, opad, opad, startup, startup_virtex, startup_virtex2, tck, tms, upad, upad, upad, upad

public abstract class VisibleAnnotation

extends Cell

This class provides a Cell class that cannot be simulated It can only be used to annotate the circuit and was provided primarily for use by the techmapper. VisibleAnnotation does not and should not extend Annotation, but implements all the same methods. This is to give all the functionality of Annotation, except that VisibleAnnotation's will be shown in the schematic and circuit viewers.

Field Summary

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

VisibleAnnotation(Node parent)
Construct an unnamed annotation

VisibleAnnotation(Node parent, boolean sim)
Construct a named annotation, param sim is ignored

VisibleAnnotation(Node parent, java.lang.String name)
Construct an unnamed annotation

VisibleAnnotation(Node parent, java.lang.String name, boolean sim)
Construct a named annotation, param sim is ignored

Method Summary

boolean	hasBehaviorInClockMethod() Annotations have no behavior
boolean	hasBehaviorInPropagateMethod() Annotations have no behavior
boolean	needsToBeAsynchronouslyScheduled() Visible annotations are unscheduled in simulation

Methods inherited from class byucc.jhdl.base.Cell

addPort, addPorts, addProperties, addProperties, addProperty, addProperty, addProperty, addProperty, antecedantIsBehaviorallyModeled, antecedantIsBehaviorallyModeled, behavioralModelIsAvailable, bind, bind, bind, bind, cellInterfaceDeterminesUniqueNetlistStructure, clk, connect, connectAllWires, connectOptional, constructSubCell, constructSubCellNoImplicitPorts, defaultSimulationModelIsBehavioral, disableAllBehavioralModels, disableBehavioralModel, enableBehavioralModel, getArgument, getAttachedPort, getAttachedWire, getAttachedWireNoException, getCellName, getCellNetlist, getCellNetList, getCellNetlist, getCellNetlist, getDescendents, getFlatNetlist, getFlatNetlistableChildren, getGeneric, getHeight, getNetlistableChildren, getPlacementInfo, getPortProperties, getPortRecord, getPortRecords, getProperties, getProperty, getPropertyValue, getSinkWires, getSourceWires, getSubCellClass, getUniqueCellName, getWidth, getX, getY, hasBeenTraced, hasBeenTraced, hasPort, hasPorts, in, in, inout, inout, isAsynchronouslyScheduled, isAsynchronouslyScheduled, 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, removeAllUnconnectedPorts, removePort, removeProperty, replaceProperty, replaceProperty, resetBehavioralModelsToDefaults, setAsynchronousSourceSinkResolved, setGeneric, setHeight, setNotNetlistable, setNotNetlistable, setNotVisible, setNotVisible, setPlacementInfo, setPortNotNetlistable, setPortNotNetlistable, setProperty, 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

VisibleAnnotation

public VisibleAnnotation(Node parent,
                         java.lang.String name,
                         boolean sim)

Construct a named annotation, param sim is ignored

Parameters:

parent - the parent node

name - the name

sim - is this simulatable?--Always false!

VisibleAnnotation

public VisibleAnnotation(Node parent,
                         boolean sim)

Construct a named annotation, param sim is ignored

Parameters:

parent - the parent node

sim - is this simulatable?--Always false!

VisibleAnnotation

public VisibleAnnotation(Node parent,
                         java.lang.String name)

Construct an unnamed annotation

Parameters:

parent - the parent node

name - the name

VisibleAnnotation

public VisibleAnnotation(Node parent)

Construct an unnamed annotation

Parameters:

parent - the parent node

Method Detail

needsToBeAsynchronouslyScheduled

public boolean needsToBeAsynchronouslyScheduled()

Visible annotations are unscheduled in simulation

Specified by:

needsToBeAsynchronouslyScheduled in class Cell

Returns:

false

hasBehaviorInPropagateMethod

public boolean hasBehaviorInPropagateMethod()

Annotations have no behavior

Specified by:

hasBehaviorInPropagateMethod in class Cell

Returns:

false

hasBehaviorInClockMethod

public boolean hasBehaviorInClockMethod()

Annotations have no behavior

Specified by:

hasBehaviorInClockMethod in class Cell

Returns:

false