Package byucc.edif

Provides a data structure for representing and manipulating EDIF 2.0.0 files

See:
Description

Interface Summary

EdifNameable	Used for names that require both the Nameable interface and the ability to be printed in the Edif format.
EdifNameSpace	A group of Nameable objects each with a unique String name.
EdifOut	Used for objects that can generate valid EDIF output.
Nameable	Used for objects that can be named with a String name.
NameSpaceResolver	Resolves String name conflicts.
Properties	Defines an interface for objects that can be annotated with Properties.
Trimable	This interface is used for classes that can "trim" the data structures alloacted by the class.

Class Summary

AbstractEdifNameSpace	An abstract implementation of the EdifNameSpace.
AbstractNameSpaceResolver	Abstract class that contains methods for name space resolvers.
ArrayListNameSpaceResolver	Implements a name space using an ArrayList.
AutoTest	Designed for auto testing the functionality of the whole EDIF package.
BasicStringIncrementer	Provides methods for "incrementing" a String value.
BooleanTypedValue	Signifies that the EDIF file has a Boolean value type.
EdifBusNameOps	Contains methods for parsing bus-related information from String Objects.
EdifCell	Represents an EDIF cell definition.
EdifCellInstance	Represents a specific instance of an EdifCell object.
EdifCellInterface	Represents the port interface of an EdifCell object.
EdifDesign	Represents an EdifDesign within an EdifEnvironment object.
EdifEnvironment	Represents a complete EdifEnvironment.
EdifHelpers	Represents a place to experiment with new helper methods that may eventually be incorporated into the main Edif classes.
EdifLibrary	Represents a library which is an ordered list of EdifCell objects.
EdifLibraryManager	Represents a List of related EdifLibraries.
EdifNameSpaceList
EdifNameSpaceMap
EdifNet	Represents an EDIF signal net.
EdifNumber	Extends ArrayList, and stores ScaledInteger objects.
EdifPort	Represents an Edif port, which belongs to a specific EdifCell.
EdifPortRef	Represents a port reference within an EdifEnvironment.
EdifPrintWriter	Used for generating valid Edif text output.
EdifSingleBitPort	Represents an Edif single bit port, which belongs to a specific EdifPort.
EdifUtils	Contains a collection of static utility methods.
ExpValue	Represents a base number with an exponent value.
HashMapNameSpaceResolver	Implements an unordered name space using a HashMap.
IntegerTypedValue	Signifies that the EDIF file has an Integer value type.
NamedObject	Provides a String name and the ability to create Edif output by implementing the EdifNameable interface.
NamedObjectCompare	Compares NamedObject objects.
NamedPropertyObject	Represents a container class that contains an EdifNameable object (to define the name of this object) as well as a PropertyList object to store all properties of the object.
NewTypedValue	Represents the typed value of the EDIF file
NumberTypedValue	Signifies that the EDIF file has a Number value type.
Property	Specifies a String name/value pair to describe an EDIF property.
PropertyList	Provides a LinkedHashMap of Property objects.
RenamedObject	Represents Edif names that are renamed using the RENAME keyword.
ScaledInteger	Represents an integer that can hold either of two types: int, and ExpValue.
StringTypedValue	Signifies that the EDIF file has a String value type.

Exception Summary

EdifNameConflictException
EdifRuntimeException	Contains error information in regards to errors in the EDIF processing.

Package byucc.edif Description

Provides a data structure for representing and manipulating EDIF 2.0.0 files.

Related Links

• Official EDIF Website
• EDIF Overview
• EDIF Overview in Application-Specific Integrated Circuits

Package To Dos

• When adding a reference setting the library for a cell, what about the cell being added to that library?
• Setting references for all Edif objects (ie, setting the EdifNet an EdifPortRef is associated with, and then adding that EdifPortRef to the EdifNet)
• Renaming: currently working on this.
• We may want to add a "byucc.edif.util" directory. This could contain classes such as NameSpaceResolver, Nameable, NamedObject, Property stuff, etc.
• When adding a voter cell to the edif library (when necessary), should a separate library be created, and added to the same EdifDesign?
• Come up with an auto-testing strategy (see AutoTest)