edu.byu.ece.edif.tools.replicate.nmr
Class AbstractOrganSpecification

java.lang.Object
  extended by edu.byu.ece.edif.tools.replicate.nmr.AbstractOrganSpecification
All Implemented Interfaces:
OrganSpecification, java.io.Serializable
Direct Known Subclasses:
DetectorOrganSpecification, RestoringOrganSpecification

public abstract class AbstractOrganSpecification
extends java.lang.Object
implements OrganSpecification

An organ specification is an indication of where to put a particular kind of organ during replication, how many to place, and what to do with the outputs. OrganSpecifications come in two main types: RestoringOrganSpecifications and DetectorOrganSpecifications.

See Also:
Serialized Form

Field Summary
protected  EdifNet _net
           
protected  int _organCount
           
protected  Organ _organType
           
 
Constructor Summary
AbstractOrganSpecification(Organ organType, int organCount, EdifNet net)
          Create a new OrganSpecification with the given organ type, number of organs, and net.
 
Method Summary
 EdifNet getEdifNet()
          Get the orginal EdifNet associated with the organ specification
 int getOrganCount()
          Get the number of organs specified.
 Organ getOrganType()
          Get the type of organ specified.
abstract  java.util.List<EdifPortRef> getSinksGettingOrganOutputs()
          Get the list of sinks that need to get organ outputs.
 void promoteOrganCountUpTo(int organCount)
          Increase the number of organs in the specification up to organCount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_net

protected EdifNet _net

_organType

protected Organ _organType

_organCount

protected int _organCount
Constructor Detail

AbstractOrganSpecification

public AbstractOrganSpecification(Organ organType,
                                  int organCount,
                                  EdifNet net)
Create a new OrganSpecification with the given organ type, number of organs, and net.

Parameters:
organType -
organCount -
net -
Method Detail

getOrganType

public Organ getOrganType()
Get the type of organ specified.

Specified by:
getOrganType in interface OrganSpecification
Returns:

getOrganCount

public int getOrganCount()
Get the number of organs specified.

Specified by:
getOrganCount in interface OrganSpecification
Returns:

getSinksGettingOrganOutputs

public abstract java.util.List<EdifPortRef> getSinksGettingOrganOutputs()
Get the list of sinks that need to get organ outputs.

Specified by:
getSinksGettingOrganOutputs in interface OrganSpecification
Returns:

getEdifNet

public EdifNet getEdifNet()
Get the orginal EdifNet associated with the organ specification

Specified by:
getEdifNet in interface OrganSpecification
Returns:
the net which this specification refers to

promoteOrganCountUpTo

public void promoteOrganCountUpTo(int organCount)
Description copied from interface: OrganSpecification
Increase the number of organs in the specification up to organCount

Specified by:
promoteOrganCountUpTo in interface OrganSpecification