oaOccurrence

模块: oapy._oa._design 导入: from oapy._oa import _design

概览

oaOccurrence 在 oapy 中可用，可通过 _design 模块访问。

本页汇总 oaOccurrence 当前在 oapy 中可用的 Python 接口。

详细说明

The occurrence domain is a fully unfolded hierarchy that contains a union of the connectivity objects in the block and the module domains。 See Understanding EMH in the Programmer's Guide for more discussion。 The oaOccurrence class represents an occurrence of an oaBlock and/or an oaModule in the occurrence hierarchy。 An oaDesign may have zero or one top oaOccurrence。 Except for a top occurrence, each oaOccurrence has a single oaOccInst that is its parent。 An oaOccurrence also has zero or more occInsts that are its children。 Occurrences will only exist where the occurrence hierarchy has been expanded in the current session by starting at the top occurrence and calling oaOccInst::getMasterOccurrence(true)。 Occurrence objects will appear in the hierarchy representing all module objects that are instantiated under the top module and all block connectivity objects。 The oaOccurrence class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.destroy()
✅	obj.getBlock()
✅	obj.getModule()
✅	obj.getOccInst()
✅	obj.getTermsByPosition(array)
✅	obj.uniquify()
✅	obj.uniquify(modName)
✅	obj.getAssignments()
✅	obj.getBusNetDefs()
✅	obj.getBusTermDefs()
✅	obj.getConnectDefs()
✅	obj.getModuleInstHeaders()
✅	obj.getInsts(filterFlags=oacInstIterNotImplicit)
✅	obj.getInstTerms(filterFlags=oacInstTermIterNotImplicit)
✅	obj.getNets(filterFlags=oacNetIterAll|oacNetIterNotImplicit)
✅	obj.getTerms(filterFlags=oacTermIterAllNotHidden|oacTermIterNotImplicit)
✅	obj.getVectorInstDefs()

方法说明

obj.destroy()

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this occurrence and the occurrence hierarchy below it, removing them from the database。

异常

• oacOccDestroyRequiresUndoToBeDisabled。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.destroy()

obj.getBlock()

绑定状态: 已绑定

Python 调用: obj.getBlock()

This function returns the block that corresponds to (or contains) this occurrence。 This will return NULL for an occurrence of a module that is not visible in the block domain。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getBlock()

obj.getModule()

绑定状态: 已绑定

Python 调用: obj.getModule()

This function returns the module that corresponds to this occurrence。 This will return NULL for an occurrence of a block that is not visible in the module domain。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getModule()

obj.getOccInst()

绑定状态: 已绑定

Python 调用: obj.getOccInst()

This function returns the parent instance of this occurrence。 Every occurrence has exactly one parent occInst, except the top occurrence which has no occInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getOccInst()

obj.getTermsByPosition(array)

绑定状态: 已绑定

Python 调用: obj.getTermsByPosition(array)

This function retrieves the terminals in this occurrence that have been assigned a position and returns them in the specified oaOccTermArray 。 A position in the array may be NULL to reflect that there is no terminal assigned to that position。 The position of a terminal in the array reflects the position assigned to the terminal。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getTermsByPosition(array)

obj.uniquify()

绑定状态: 已绑定

Python 调用: obj.uniquify()

This function ensures that this is the only occurrence of this module, creating a new module variant if necessary。 This operation is applied recursively up the hierarchy, stopping when an occurrence that is already unique is reached。 It explicitly does not uniquify occurrences in the hieararchy below the given occurrence。 This version uses an explicitly specified name for the module。 The uniquified occurrences refer to new modules, and existing module domain pointers are affected by this function。 If you have module object pointers aquired before uniquify, you should reaquire the pointers by doing a find operation。 Calling this function on the top oaOccurrence of an oaDesign , or on any other unique oaOccurrence, does nothing。 Instead, call this function on an oaOccurrence of a non-unique oaModule , that is, an oaModule that is instantiated more than once。

参数

• modName: The name of the new module。

异常

• oacModuleExists。
• oacModuleAndOccurrenceNotInSameDesign。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.uniquify()

obj.uniquify(modName)

绑定状态: 已绑定

Python 调用: obj.uniquify(modName)

This function ensures that this is the only occurrence of this module, creating a new module variant if necessary。 This operation is applied recursively up the hierarchy, stopping when an occurrence that is already unique is reached。 It explicitly does not uniquify occurrences in the hieararchy below the given occurrence。 This version creates the module with an automatically generated name。 The uniquified occurrences refer to new modules, and existing module domain pointers are affected by this function。 If you have module object pointers aquired before uniquify, you should reaquire the pointers by doing a find operation。 Calling this function on the top oaOccurrence of an oaDesign , or on any other unique oaOccurrence, does nothing。 Instead, call this function on an oaOccurrence of a non-unique oaModule , that is, an oaModule that is instantiated more than once。

异常

• oacModuleAndOccurrenceNotInSameDesign。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.uniquify(modName)

obj.getAssignments()

绑定状态: 已绑定

Python 调用: obj.getAssignments()

This function returns a collection of the assignments in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getAssignments()

obj.getBusNetDefs()

绑定状态: 已绑定

Python 调用: obj.getBusNetDefs()

This function returns a collection of the busNetDefs in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getBusNetDefs()

obj.getBusTermDefs()

绑定状态: 已绑定

Python 调用: obj.getBusTermDefs()

This function returns a collection of the busTermDefs in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getBusTermDefs()

obj.getConnectDefs()

绑定状态: 已绑定

Python 调用: obj.getConnectDefs()

This function returns a collection of the connectDefs in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getConnectDefs()

obj.getModuleInstHeaders()

绑定状态: 已绑定

Python 调用: obj.getModuleInstHeaders()

This function returns a collection of the moduleInstHeaders in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getModuleInstHeaders()

obj.getInsts(filterFlags=oacInstIterNotImplicit)

绑定状态: 已绑定

Python 调用: obj.getInsts(filterFlags=oacInstIterNotImplicit)

This function returns a collection of instances in this occurrence。 The filter flag bits are defined below and may be logically OR'd together to refine the contents of the collection。

参数

• filterFlags: Specifies what the collection contains。 The bit flags are defined as follows: oacInstIterSingleBit: the collection contains single-bit instances oacInstIterNotImplicit: the collection will not contain any implicitly created instances。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getInsts(filterFlags=oacInstIterNotImplicit)

obj.getInstTerms(filterFlags=oacInstTermIterNotImplicit)

绑定状态: 已绑定

Python 调用: obj.getInstTerms(filterFlags=oacInstTermIterNotImplicit)

This function returns a collection of the instTerms in this occurrence。

参数

• filterFlags: Specifies what the collection contains。 The bits flags are defined as follows:。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getInstTerms(filterFlags=oacInstTermIterNotImplicit)

obj.getNets(filterFlags=oacNetIterAll|oacNetIterNotImplicit)

绑定状态: 已绑定

Python 调用: obj.getNets(filterFlags=oacNetIterAll|oacNetIterNotImplicit)

This function returns a collection of nets in this occurrence。 The filter flag bits are defined below:。

参数

• filterFlags: This specifies what the collection contains。 The bit flags are defined as follows: oacNetIterAll: the collection contains all nets oacNetIterSingleBit: the collection contains single-bit nets oacNetIterBundle: the collection contains all the bundleNets in the occurrence oacNetIterGlobal: the collection contains a representative occNet for every global signal referenced anywhere in the occurrence hierarchy containing this occurrence oacNetIterPreferred: the collection only contains the preferred nets; equivalent nets are omitted oacNetIterNotImplicit: the collection contains explicitly created nets。

异常

• oacInvalidOccurrenceNetIterFlags。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getNets(filterFlags=oacNetIterAll|oacNetIterNotImplicit)

obj.getTerms(filterFlags=oacTermIterAllNotHidden|oacTermIterNotImplicit)

绑定状态: 已绑定

Python 调用: obj.getTerms(filterFlags=oacTermIterAllNotHidden|oacTermIterNotImplicit)

This function returns a collection of terms in this occurrence。 The filter flag bits are defined below:。

参数

• filterFlags: Specifies what the collection contains。 The bit flags are defined as follows: oacTermIterAllNotHidden: the collection contains all terminals that are not hidden oacTermIterAll: the collection contains all terminals oacTermIterSingleBit: the collection contains single-bit terminals oacTermIterBundle: the collection contains all the bundleTerms in the occurrence oacTermIterNotImplicit: the collection contains explicitly created terminals。

异常

• oacInvalidOccurrenceTermIterFlags。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getTerms(filterFlags=oacTermIterAllNotHidden|oacTermIterNotImplicit)

obj.getVectorInstDefs()

绑定状态: 已绑定

Python 调用: obj.getVectorInstDefs()

This function returns a collection of the vectorInstDefs in this occurrence。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccurrence
obj.getVectorInstDefs()