edu.byu.ece.edif.core
Class EdifDesign

java.lang.Object
  extended by edu.byu.ece.edif.core.NamedPropertyObject
      extended by edu.byu.ece.edif.core.EdifDesign
All Implemented Interfaces:
EdifOut, Properties, java.io.Serializable

public class EdifDesign
extends NamedPropertyObject
implements EdifOut

Represents an EdifDesign within an EdifEnvironment object. An EdifDesign identifies the cell instance at the top level of the hierarchy of an Edif file. A design has a name (renamed if necessary), properties, and an EdifCellInstance. Note that the name of the design may be different than the name of the top EdifCellInstance.

Version:
$Id:EdifDesign.java 198 2008-04-16 21:14:21Z jamesfcarroll $
See Also:
EdifEnvironment, Serialized Form

Field Summary
private  EdifCellInstance _topCellInstance
          The top EdifCellInstance of this design.
 
Constructor Summary
EdifDesign(EdifNameable name)
          Construct an empty, named EdifDesign Object
EdifDesign(java.lang.String name)
          Construct an empty, named EdifDesign Object
 
Method Summary
 EdifCellInstance getTopCellInstance()
          Return the top cell instance of this design.
 void setTopCellInstance(EdifCellInstance cellInstance)
          Set the top EdifCellInstance of this design.
 void toEdif(EdifPrintWriter epw)
          Generate the EDIF text for this object.
 java.lang.String toString()
          Return a String representation of this Object.
 
Methods inherited from class edu.byu.ece.edif.core.NamedPropertyObject
addProperty, addProperty, addPropertyList, copyProperties, equals, equalsProperties, getEdifNameable, getName, getOldName, getProperty, getPropertyList, rename, rename, rename
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_topCellInstance

private EdifCellInstance _topCellInstance
The top EdifCellInstance of this design.

Constructor Detail

EdifDesign

public EdifDesign(java.lang.String name)
           throws InvalidEdifNameException
Construct an empty, named EdifDesign Object

Parameters:
name - The name of this EdifDesign Object
Throws:
InvalidEdifNameException

EdifDesign

public EdifDesign(EdifNameable name)
Construct an empty, named EdifDesign Object

Parameters:
name - The Object that holds name information for this EdifDesign Object
Method Detail

getTopCellInstance

public EdifCellInstance getTopCellInstance()
Return the top cell instance of this design.

Returns:
an EdifCellInstance Object that refers to the top EdifCell of this design

setTopCellInstance

public void setTopCellInstance(EdifCellInstance cellInstance)
Set the top EdifCellInstance of this design.

Parameters:
cellInstance - The EdifCellInstance Object that this EdifDesign Object will refer to

toEdif

public void toEdif(EdifPrintWriter epw)
Generate the EDIF text for this object.

Specified by:
toEdif in interface EdifOut
Parameters:
epw - The EdifPrintWriter Object that will write this Object's EDIF data to

toString

public java.lang.String toString()
Return a String representation of this Object.

Overrides:
toString in class java.lang.Object
Returns:
A String representing this object, and the top EdifCellInstance