byucc.jhdl.DRC.Rules
Class Template

java.lang.Object
  byucc.jhdl.DRC.DesignRule
      byucc.jhdl.DRC.Rules.Template

All Implemented Interfaces:

DesignRuleConstants

public class Template

extends DesignRule

Field Summary

Fields inherited from class byucc.jhdl.DRC.DesignRule

cellList, checker, checkOk, description, enabled, failureReport, name, oneLineDescription, violatingCells

Fields inherited from interface byucc.jhdl.DRC.DesignRuleConstants

MSGHEADER_ERROR, MSGHEADER_NOTICE, MSGHEADER_STATUS, MSGHEADER_WARNING, MSGTYPE_ERR_ALL, MSGTYPE_ERR_EXPERTWARN, MSGTYPE_ERR_NOEXPERT, MSGTYPE_ERROR_BITS, MSGTYPE_MUTE, MSGTYPE_NOTICE, MSGTYPE_NOTICE_BITS, MSGTYPE_NOTICE_NOEXPERT, MSGTYPE_STATUS, MSGTYPE_STATUS_BITS, MSGTYPE_STATUS_NOEXPERT, MSGTYPE_WARN_ALL, MSGTYPE_WARN_NOEXPERT, MSGTYPE_WARNING_BITS, SHOW_NUM_RULES_CHECKED_EVERY

Constructor Summary

Template()

Method Summary

boolean	doCheck() Initiates the design rule check for this DesignRule.
void	sortCell(Cell cl) To be implemented by subclasses so they may sort cells into appropriate containers.

Methods inherited from class byucc.jhdl.DRC.DesignRule

addToCellList, addToCellList, addViolatingCell, checkOk, displayMsgHeader, getDescription, getDesignRuleChecker, getName, getOneLineDescription, getReport, getViolatingCells, msg, msg, msg, msg, msgln, msgln, registerViolation, resetState, setCurrentMsgType, setDesignRuleCheckerReference, setName, setReport, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template()

Method Detail

sortCell

public void sortCell(Cell cl)

Description copied from class: DesignRule

To be implemented by subclasses so they may sort cells into appropriate containers. This method is called by the DesignRuleChecker for each descendant of the top-level cell. The DesignRuleChecker calls this method before it calls the doCheck method. Note this this may not apply to sorting cells only; for example, it could deal with wires, where the design rule only applied to the properties of the wires.

Specified by:

sortCell in class DesignRule

Parameters:

cl - A subcell of the top-level design. The sorting method may look at its Class (or its attributes) to determine whether it will store a reference to it. It may alternatively store the wires attached to it.

doCheck

public boolean doCheck()

Description copied from class: DesignRule

Initiates the design rule check for this DesignRule. Before this method is called, the sortCell method is called on all of the descendants of the top-level cell. This must be implemented by the writer of the design rule.

Specified by:

doCheck in class DesignRule

Returns:

true if the design rule checked is kept, otherwise false.