|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.electric.database.variable.ElectricObject
com.sun.electric.database.hierarchy.Export
public class Export
An Export is a PortProto at the Cell level. It points to the PortInst that got exported, which identifies a NodeInst and a PortProto on that NodeInst.
An Export takes a PortInst on a NodeInst and makes it available as a PortInst on instances of this NodeInst, farther up the hierarchy. An Export therefore belongs to the NodeInst that is its source and also to the Cell that the NodeInst belongs to. The data structures look like this:
Field Summary | |
---|---|
static Variable.Key |
EXPORT_NAME
Key of text descriptor of export name |
static Variable.Key |
EXPORT_REFERENCE_NAME
Key of Varible holding reference name. |
static Export[] |
NULL_ARRAY
Empty Export array for initialization. |
Method Summary | |
---|---|
void |
addVar(Variable var)
Method to add a Variable on this Export. |
boolean |
compare(java.lang.Object obj,
java.lang.StringBuffer buffer)
This function is to compare Export elements. |
int |
compareTo(Export that)
Compares Exports by their Cells and names. |
boolean |
connectsTo(ArcProto arc)
Method to return true if the specified ArcProto can connect to this Export. |
void |
copyStateBits(Export other)
Method to copy state bits from other Export. |
void |
copyVarsFrom(ElectricObject other)
Method to copy all variables from another Export to this Export. |
void |
delVar(Variable.Key key)
Method to delete a Variable from this Export. |
boolean |
doesntConnect(PrimitivePort newPP)
helper method to ensure that all arcs connected to Export "pp" at instances of its Cell (or any of its export sites) can connect to Export newPP. |
PrimitivePort |
getBasePort()
Method to return the base-level port that this PortProto is created from. |
PortCharacteristic |
getCharacteristic()
Method to return the PortCharacteristic of this Export. |
int |
getChronIndex()
Method to return chronological index of this Export in parent. |
ImmutableExport |
getD()
Returns persistent data of this Export. |
EDatabase |
getDatabase()
Returns database to which this Export belongs. |
PortProto |
getEquivalent()
Method to return the PortProto that is equivalent to this in the corresponding schematic Cell. |
Export |
getEquivalentPort(Cell otherCell)
Method to find the Export on another Cell that is equivalent to this Export. |
ExportId |
getId()
Method to return PortProtoId of this Export. |
java.lang.String |
getName()
Method to return the name of this Export. |
Name |
getNameKey()
Method to return the name key of this Export. |
Poly |
getNamePoly()
Method to return a Poly that describes this Export name. |
PortInst |
getOriginalPort()
Method to return the port on the NodeInst inside of the cell that is the origin of this Export. |
Cell |
getParent()
Method to return the parent NodeProto of this Export. |
int |
getPortIndex()
Method to get the index of this Export. |
java.lang.String |
getShortName()
Method to return the short name of this PortProto. |
static java.lang.String |
getShortName(java.lang.String name)
Method to convert name of export to short name. |
TextDescriptor |
getTextDescriptor(Variable.Key varKey)
Returns the TextDescriptor on this Export selected by variable key. |
boolean |
isAlwaysDrawn()
Method to tell whether this PortProto is always drawn. |
boolean |
isBodyOnly()
Method to tell whether this PortProto exists only in the body of a cell. |
boolean |
isDeprecatedVariable(Variable.Key key)
Method to determine whether a variable key on Export is deprecated. |
boolean |
isGlobalPartition()
Returns true if this export has its original port on Global-Partition schematics primitive. |
boolean |
isGround()
Method to determine whether this Export is of type Ground. |
boolean |
isLinked()
Returns true if this Export is linked into database. |
boolean |
isNamedGround()
Method to determine whether this Export has a name that suggests Ground. |
boolean |
isNamedPower()
Method to determine whether this Export has a name that suggests Power. |
boolean |
isPower()
Method to determine whether this Export is of type Power. |
void |
kill()
Method to unlink this Export from its Cell. |
void |
lowLevelModify(ImmutableExport d)
Method to change the origin of this Export to another place in the Cell. |
boolean |
move(PortInst newPi)
Method to move this Export to a different PortInst in the Cell. |
static Export |
newInstance(Cell parent,
ExportId exportId,
java.lang.String name,
TextDescriptor nameTextDescriptor,
PortInst originalPort,
boolean alwaysDrawn,
boolean bodyOnly,
PortCharacteristic characteristic,
ErrorLogger errorLogger)
Factory method to create an Export |
static Export |
newInstance(Cell parent,
PortInst portInst,
java.lang.String protoName)
Method to create an Export with the specified values. |
static Export |
newInstance(Cell parent,
PortInst portInst,
java.lang.String protoName,
PortCharacteristic characteristic)
Method to create an Export with the specified values. |
static Export |
newInstance(Cell parent,
PortInst portInst,
java.lang.String protoName,
PortCharacteristic characteristic,
boolean createOnIcon)
Method to create an Export with the specified values. |
void |
rename(java.lang.String newName)
Method to rename this Export. |
void |
setAlwaysDrawn(boolean b)
Method to set this PortProto to be always drawn. |
void |
setBodyOnly(boolean b)
Method to set this PortProto to exist only in the body of a cell. |
void |
setCharacteristic(PortCharacteristic characteristic)
Method to set the PortCharacteristic of this Export. |
void |
setTextDescriptor(Variable.Key varKey,
TextDescriptor td)
Updates the TextDescriptor on this Export selected by varName. |
java.lang.String |
toString()
Returns a printable version of this Export. |
Cell |
whichCell()
Method to determine the appropriate Cell associated with this ElectricObject. |
Methods inherited from class com.sun.electric.database.variable.ElectricObject |
---|
addDisplayableVariables, check, checkChanging, checkExamine, checkUndoing, computeTextPoly, copyTextDescriptorFrom, getArtwork, getCode, getDisplayableVariables, getGeneric, getInfo, getMutableTextDescriptor, getNumVariables, getParameterOrVariable, getParameterOrVariable, getParametersAndVariables, getPolyList, getSchematics, getTech, getTechPool, getTextBounds, getVar, getVar, getVariables, getVarValue, getVarValue, isDatabaseObject, isParam, newDisplayVar, newVar, newVar, newVar, newVar, numDisplayableVariables, renameVar, renameVar, setOff, uniqueObjectName, uniqueObjectName, updateVar, updateVarCode, updateVarText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Export[] NULL_ARRAY
public static final Variable.Key EXPORT_NAME
public static final Variable.Key EXPORT_REFERENCE_NAME
Method Detail |
---|
public static Export newInstance(Cell parent, PortInst portInst, java.lang.String protoName)
parent
- the Cell in which this Export resides.portInst
- the PortInst to exportprotoName
- the name of this Export.
It may not have unprintable characters, spaces, or tabs in it.
public static Export newInstance(Cell parent, PortInst portInst, java.lang.String protoName, PortCharacteristic characteristic)
parent
- the Cell in which this Export resides.portInst
- the PortInst to exportprotoName
- the name of this Export.
It may not have unprintable characters, spaces, or tabs in it.characteristic
- the characteristic (input, output) of this Export.
public static Export newInstance(Cell parent, PortInst portInst, java.lang.String protoName, PortCharacteristic characteristic, boolean createOnIcon)
parent
- the Cell in which this Export resides.portInst
- the PortInst to exportprotoName
- the name of this Export.
It may not have unprintable characters, spaces, or tabs in it.characteristic
- the characteristic (input, output) of this Export.createOnIcon
- true to create an equivalent export on any associated icon.
public static Export newInstance(Cell parent, ExportId exportId, java.lang.String name, TextDescriptor nameTextDescriptor, PortInst originalPort, boolean alwaysDrawn, boolean bodyOnly, PortCharacteristic characteristic, ErrorLogger errorLogger)
parent
- the Cell in which this Export resides.exportId
- ExportId of this Exportname
- the user name of this Export. if null then the same as id.
It may not have unprintable characters, spaces, or tabs in it.nameTextDescriptor
- text descriptor of this ExportoriginalPort
- the PortInst that is being exported.alwaysDrawn
- true if this Export is always drawn.bodyOnly
- true to exclude this Export from icon.characteristic
- PortCharacteristic of this Export.errorLogger
- error logger to report errors.
public void kill()
public void rename(java.lang.String newName)
newName
- the new name of this Export.public boolean move(PortInst newPi)
newPi
- the new PortInst on which to base this Export.
public void lowLevelModify(ImmutableExport d)
d
- the new PortInst in the cell that will hold this Export.public void copyStateBits(Export other)
other
- Export from which to take state bits.public Poly getNamePoly()
public Cell whichCell()
whichCell
in class ElectricObject
public ImmutableExport getD()
getD
in class ElectricObject
public void addVar(Variable var)
addVar
in class ElectricObject
var
- Variable to add.public void delVar(Variable.Key key)
delVar
in class ElectricObject
key
- the key of the Variable to delete.public void copyVarsFrom(ElectricObject other)
copyVarsFrom
in class ElectricObject
other
- the other Export from which to copy Variables.public ExportId getId()
getId
in interface PortProto
public Cell getParent()
getParent
in interface PortProto
public int getChronIndex()
public int getPortIndex()
getPortIndex
in interface PortProto
public TextDescriptor getTextDescriptor(Variable.Key varKey)
Export.EXPORT_NAME
.
The TextDescriptor gives information for displaying the Variable.
getTextDescriptor
in class ElectricObject
varKey
- key of variable or special key.
public void setTextDescriptor(Variable.Key varKey, TextDescriptor td)
setTextDescriptor
in class ElectricObject
varKey
- key of variable or special name.td
- new value TextDescriptorpublic boolean isDeprecatedVariable(Variable.Key key)
isDeprecatedVariable
in class ElectricObject
key
- the key of the variable.
public Name getNameKey()
getNameKey
in interface PortProto
public java.lang.String getName()
getName
in interface PortProto
public java.lang.String getShortName()
public static java.lang.String getShortName(java.lang.String name)
name
- long name
public int compareTo(Export that)
compareTo
in interface java.lang.Comparable<Export>
that
- the other Export.
public java.lang.String toString()
toString
in class ElectricObject
public PortInst getOriginalPort()
public PrimitivePort getBasePort()
getBasePort
in interface PortProto
public boolean connectsTo(ArcProto arc)
connectsTo
in interface PortProto
arc
- the ArcProto to test for connectivity.
public PortCharacteristic getCharacteristic()
getCharacteristic
in interface PortProto
public void setCharacteristic(PortCharacteristic characteristic)
characteristic
- the PortCharacteristic of this Exort.public boolean isPower()
isPower
in interface PortProto
public boolean isNamedPower()
public boolean isGround()
isGround
in interface PortProto
public boolean isNamedGround()
public boolean isGlobalPartition()
public void setAlwaysDrawn(boolean b)
public boolean isAlwaysDrawn()
public void setBodyOnly(boolean b)
b
- true if this Export exists only in the body of a cell.public boolean isBodyOnly()
public boolean isLinked()
isLinked
in class ElectricObject
public EDatabase getDatabase()
getDatabase
in class ElectricObject
public PortProto getEquivalent()
public Export getEquivalentPort(Cell otherCell)
otherCell
- the other cell to equate.
public boolean doesntConnect(PrimitivePort newPP)
public boolean compare(java.lang.Object obj, java.lang.StringBuffer buffer)
obj
- Object to compare tobuffer
- To store comparison messages in case of failure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |