oaScanChainInst Class Reference

Inheritance diagram for oaScanChainInst:

oaBlockObject oaDesignObject oaObject


Public Methods

void destroy ()
oaInst * getInstance () const
oaInstTerm * getInInstTerm () const
oaInstTerm * getOutInstTerm () const
oaUInt4 getSeqBitLength () const
void setInInstTerm (oaInstTerm *term)
void setOutInstTerm (oaInstTerm *term)
void setInstTerms (oaInstTerm *inInstTerm, oaInstTerm *outInstTerm)
void setSeqBitLength (oaUInt4 numBits)

Static Public Methods

oaScanChainInst * create (oaScanChainSet *set, oaInstTerm *inTerm, oaInstTerm *outTerm)

Public Types

enum  { dtIndex = oacScanChainInstDataType }

Detailed Description

The oaScanChainInst designates a scan latch instance in a scan chain and its scan-in and scan-out instTerms. oaScanChainInsts are grouped into sets by the oaScanChainSet class. Scan chain sets, in turn, are grouped into complete scan chains by the oaScanChain class. See the oaScanChain class for more discussion.

The oaScanChainInst class can be observed by deriving from oaObserver<oaScanChainInst>.

Member Function Documentation

oaScanChainInst * oaScanChainInst::create (  oaScanChainSet *    set,
oaInstTerm *    inTerm,
oaInstTerm *    outTerm
)  [static]
 

This function creates a scanChain instance in the specified scan chain set. The InstTerms may be NULL. If both instTerms are present, then they must be on a single instance.

Exceptions:
oacInvalidScanChainInstTerm If one of the oaInstTerms is in another design or database.
oacInstTermAlreadyInScanChain If an attempt is made to call the function with an oaInstTerm that is already part of a scan chain.
oacScanChainInstTermsNotOnSameInst If an attempt is made to specify input or output oaInstTerms that are not on the same instance.

void oaScanChainInst::destroy (    ) 
 

This function destroys this scan chain instance, removing it from the database. The oaInst that it pointed to is unaffected.

oaInstTerm * oaScanChainInst::getInInstTerm (    )  const
 

This function returns the scan-in instance terminal associated with this scan chain instance.

oaInst * oaScanChainInst::getInstance (    )  const
 

This function returns the instance associated with this scan chain instance object.

oaInstTerm * oaScanChainInst::getOutInstTerm (    )  const
 

This function returns the scan-out instance terminal associated with this scan chain instance.

oaUInt4 oaScanChainInst::getSeqBitLength (    )  const
 

This function returns the number of sequential bits this instance represents in a scanChain partition.

void oaScanChainInst::setInInstTerm (  oaInstTerm *    term ) 
 

This function sets the scan-in instance terminal for this scan chain instance.

Exceptions:
oacInvalidScanChainInstTerm If one of the oaInstTerms is in another design or database.
oacInstTermAlreadyInScanChain If an attempt is made to call the function with an oaInstTerm that is already part of a scan chain.
oacScanChainInstTermsNotOnSameInst If an attempt is made to specify input or output oaInstTerms that are not on the same instance.

void oaScanChainInst::setInstTerms (  oaInstTerm *    inInstTerm,
oaInstTerm *    outInstTerm
) 
 

This function sets both the scan-in and scan-out instance terminals associated with this scan chain instance.

Exceptions:
oacInvalidScanChainInstTerm If one of the oaInstTerms is in another design or database.
oacInstTermAlreadyInScanChain If an attempt is made to call the function with an oaInstTerm that is already part of a scan chain.
oacScanChainInstTermsNotOnSameInst If an attempt is made to specify input or output oaInstTerms that are not on the same instance.

void oaScanChainInst::setOutInstTerm (  oaInstTerm *    term ) 
 

This function sets the scan-out instance terminal associated with this scan chain instance.

Exceptions:
oacInvalidScanChainInstTerm If one of the oaInstTerms is in another design or database.
oacInstTermAlreadyInScanChain If an attempt is made to call the function with an oaInstTerm that is already part of a scan chain.
oacScanChainInstTermsNotOnSameInst If an attempt is made to specify input or output oaInstTerms that are not on the same instance.

void oaScanChainInst::setSeqBitLength (  oaUInt4    numBits ) 
 

This function sets the number of sequential bits this scanChainInst represents in a partition length.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

The documentation for this class was generated from the following files:

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.