oaScanChainSet Class Reference

Inheritance diagram for oaScanChainSet:

oaBlockObject oaDesignObject oaObject


Public Methods

void destroy ()
oaCollection< oaScanChainInst, oaScanChainSet > getInstances () const

Static Public Methods

oaScanChainSet * create (oaScanChain *scanChain, oaScanChainSetType setType)

Public Types

enum  { dtIndex = oacScanChainSetDataType }

Detailed Description

The oaScanChainSet class collects a set of oaScanChainInst objects that are intended to be implemented on a single scan chain. The complete scan chain may have multiple oaScanChainSets. See oaScanChain for a discussion of the scan chain data model.

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


Member Function Documentation

oaScanChainSet * oaScanChainSet::create oaScanChain *    scanChain,
oaScanChainSetType    setType
[static]
 

This function creates a new set to collect scan instances in the specified oaScanChain object. This set may specify the intended order of the instances in the final design, or it may be unordered to indicate that the ordering will be determined later. At most one set in any scan chain may be unordered.

Parameters:
scanChain The scan chain in which to create an instance set
setType Indicates whether this set is ordered or unordered
Exceptions:
oacErrorCanOnlyHaveOneUnorderedSet 

void oaScanChainSet::destroy  
 

This function destroys this scan chain set, removing it from the database.

oaCollection oaScanChainSet::getInstances   const
 

This function returns a collection of the scan instances in this set.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 


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

Return to top of page