oaModule

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

概览

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

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

详细说明

The oaModule class represents a level of hierarchy in the module domain of a design。 The module domain is used to represent the logical hierarchy that may have several levels of hierarchy for each level in the block hierarchy。 OpenAccess will maintain the correspondence between the module hierarchy and the block hierarchy for all module objects that are underneath a design's top module。 There are zero or one top modules in a design。 A module may be created directly through the oaModule API, by embedding the top module from a foreign design into a design, and through uniquification。 The oaModule class can be observed by deriving from oaObserver 。 See Understanding EMH in the Programmers Guide for more information about the module domain。

方法总览

状态	Python 调用
✅	_design.oaModule.destroy()
✅	obj.detach(libName, cellName, viewName, view=oacInheritFromSourceModuleDetachVisibility)
✅	obj.getName(name)
✅	obj.getName(nameSpace, nameStr)
✅	obj.getOrig(name, libName, cellName, viewName)
✅	obj.isDerived()
✅	obj.isEmbedded()
✅	obj.isVariant(module)
✅	obj.isClone(module)
✅	obj.isOrigModified(module)
✅	obj.getBlock()
✅	obj.getTermsByPosition(array)
✅	obj.hasDefaultConstraintGroup()
✅	obj.getDefaultConstraintGroup()
✅	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=oacTermIterAll|oacTermIterNotImplicit)
✅	obj.getVectorInstDefs()
✅	obj.getOccurrences(top)
✅	_design.oaModule.create(design, name)
✅	_design.oaModule.create(design)
✅	_design.oaModule.find(design, name)
✅	_design.oaModule.embed(design, master)

方法说明

_design.oaModule.destroy()

绑定状态: 已绑定

Python 调用: _design.oaModule.destroy()

This function destroys this module。 If this module is the top module of the design, the top block of the design and all block-domain objects in the top block also will be deleted。

Python 示例

from oapy._oa import _design

_design.oaModule.destroy()

obj.detach(libName, cellName, viewName, view=oacInheritFromSourceModuleDetachVisibility)

绑定状态: 已绑定

Python 调用: obj.detach(libName, cellName, viewName, view=oacInheritFromSourceModuleDetachVisibility)

This function detaches this module and the module domain hierarchy rooted under it by moving them from the owning design into a new design。 The modules are removed from the original design and the module instances will become design instances。 The new design is created with the specified lib/cell/view names and the pointer to it is returned。 An exception is thrown if a design with the specified lib/cell/view names already exists。 Note: This operation cannot be undone and it is an explicit requirement that undo be disabled for the module's design before attempting this operation。 An exception will be thrown if undo is not disabled before this operation。 Undo can be re-enabled after the operation is complete。 For more information, see Embedding and Detaching Module Hierarchies in the Programmers Guide。

参数

• libName: The library name of the new design。
• cellName: The cell name of the new design。
• viewName: The view name of the new design。
• view: Specifies the visibility of the detached module。

异常

• oacModuleDetachDesignExists。
• oacModuleDetachRequiresUndoToBeDisabled。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.detach(libName, cellName, viewName, view=oacInheritFromSourceModuleDetachVisibility)

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this module in the specified string in the given nameSpace。

参数

• nameSpace: The nameSpace used to generate the name string。
• nameStr: The name of the module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getName(name)

obj.getName(nameSpace, nameStr)

绑定状态: 已绑定

Python 调用: obj.getName(nameSpace, nameStr)

This function returns the name of this module。

参数

• name: The returned module name。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getName(nameSpace, nameStr)

obj.getOrig(name, libName, cellName, viewName)

绑定状态: 已绑定

Python 调用: obj.getOrig(name, libName, cellName, viewName)

This function returns the name of the original module and the library, cell, and view names of the design containing the original module。 An exception is thrown if this module is not derived from another module。

参数

• name: The name of the original module。
• libName: The library name of the design containing the original module。
• cellName: The cell name of the design containing the original module。
• viewName: The view name of the design containing the original module。

异常

• oacModuleNotDerived。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getOrig(name, libName, cellName, viewName)

obj.isDerived()

绑定状态: 已绑定

Python 调用: obj.isDerived()

This function indicates whether this module was created with a uniquify call on another module in the same design。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.isDerived()

obj.isEmbedded()

绑定状态: 已绑定

Python 调用: obj.isEmbedded()

This function indicates whether this module was created by an embed() call that copied it from another design into its current database。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.isEmbedded()

obj.isVariant(module)

绑定状态: 已绑定

Python 调用: obj.isVariant(module)

This function returns true if this module originated from the specified module (via a detach, uniquify, or embed operation), and this module has been changed since that operation。 Otherwise it returns false。 It is an error if the current module did not originate from the specified module。

异常

• oacModuleNotDerived。
• oacModuleNotDerivedFromModule。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.isVariant(module)

obj.isClone(module)

绑定状态: 已绑定

Python 调用: obj.isClone(module)

This function returns true if this module originated from the specified module (via a detach, uniquify, or embed operation), and neither this module nor the specified module has been changed since that operation。 Otherwise it returns false。 It is an error if the current module did not originate from the specified module。

异常

• oacModuleNotDerived。
• oacModuleNotDerivedFromModule。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.isClone(module)

obj.isOrigModified(module)

绑定状态: 已绑定

Python 调用: obj.isOrigModified(module)

This function returns true if this module was derived from the specified module, and the specified module has been changed since that derivation, otherwise it returns false。 It is an error if the current module was not derived from the specified module。

异常

• oacModuleNotDerived。
• oacModuleNotDerivedFromModule。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.isOrigModified(module)

obj.getBlock()

绑定状态: 已绑定

Python 调用: obj.getBlock()

This function returns the block that corresponds to this module。 Only top modules may have a corresponding block -- the top block in the same design。 The correspondence of a top module and a top block is established by the visibleToBlock parameter passed to oaDesign::setTopModule and the visibleToModule parameter passed to oaBlock::create 。 This function returns NULL if this module is not a top module or if it is a top module but does not have a corresponding block。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getBlock()

obj.getTermsByPosition(array)

绑定状态: 已绑定

Python 调用: obj.getTermsByPosition(array)

This function retrieves the terminals in this module that have been assigned a position and returns them in the specified oaModTermArray 。 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 oaModule
obj.getTermsByPosition(array)

obj.hasDefaultConstraintGroup()

绑定状态: 已绑定

Python 调用: obj.hasDefaultConstraintGroup()

This function returns a boolean indicating whether there is a default constraint group for this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.hasDefaultConstraintGroup()

obj.getDefaultConstraintGroup()

绑定状态: 已绑定

Python 调用: obj.getDefaultConstraintGroup()

This function returns the default constraint group for this module。 If no constraints have been set on the default constraint group, a new constraint group is created and returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getDefaultConstraintGroup()

obj.getAssignments()

绑定状态: 已绑定

Python 调用: obj.getAssignments()

This function returns a collection of assignments in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getAssignments()

obj.getBusNetDefs()

绑定状态: 已绑定

Python 调用: obj.getBusNetDefs()

This function returns a collection of busNetDefs in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getBusNetDefs()

obj.getBusTermDefs()

绑定状态: 已绑定

Python 调用: obj.getBusTermDefs()

This function returns a collection of busTermDefs in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getBusTermDefs()

obj.getConnectDefs()

绑定状态: 已绑定

Python 调用: obj.getConnectDefs()

This function returns a collection of connectDefs in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getConnectDefs()

obj.getModuleInstHeaders()

绑定状态: 已绑定

Python 调用: obj.getModuleInstHeaders()

This function returns a collection of moduleInstHeaders in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getModuleInstHeaders()

obj.getInsts(filterFlags=oacInstIterNotImplicit)

绑定状态: 已绑定

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

This function returns a collection of instances in this module。 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 oaModule
obj.getInsts(filterFlags=oacInstIterNotImplicit)

obj.getInstTerms(filterFlags=oacInstTermIterNotImplicit)

绑定状态: 已绑定

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

This function returns a collection of instTerms in this module。

参数

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

Python 示例

from oapy._oa import _design

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

obj.getNets(filterFlags=oacNetIterAll|oacNetIterNotImplicit)

绑定状态: 已绑定

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

This function returns a collection of nets in this module。 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 module 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。

异常

• oacInvalidModuleNetIterFlags。

Python 示例

from oapy._oa import _design

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

obj.getTerms(filterFlags=oacTermIterAll|oacTermIterNotImplicit)

绑定状态: 已绑定

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

This function returns a collection of terms in this module。 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 module oacTermIterNotImplicit: the collection contains explicitly created terminals。

异常

• oacInvalidModuleTermIterFlags。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getTerms(filterFlags=oacTermIterAll|oacTermIterNotImplicit)

obj.getVectorInstDefs()

绑定状态: 已绑定

Python 调用: obj.getVectorInstDefs()

This function returns a collection of vectorInstDefs in this module。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getVectorInstDefs()

obj.getOccurrences(top)

绑定状态: 已绑定

Python 调用: obj.getOccurrences(top)

This function returns a collection of all the occurrences of this module in the design hierarchy under the specified top occurrence。 It is an error if the top occurrence specified is not in the same design as the module。 Note: The resulting collection will be empty unless the occurrence hierarchy under the specified top occurrence has been expanded in the current session。 For more information see oaOccInst::getMasterOccurrence 。

Python 示例

from oapy._oa import _design

# assume obj is a oaModule
obj.getOccurrences(top)

_design.oaModule.create(design, name)

绑定状态: 已绑定

Python 调用: _design.oaModule.create(design, name)

This function creates a module in the given design。 The name of the module is automatically generated。

参数

• design: The design in which to create the module。

Python 示例

from oapy._oa import _design

_design.oaModule.create(design, name)

_design.oaModule.create(design)

绑定状态: 已绑定

Python 调用: _design.oaModule.create(design)

This function creates a module in the given design with the specified name。

参数

• design: The design in which to create the module。
• name: The name of the module。

异常

• oacModuleExists。
• oacInvalidDesign。

Python 示例

from oapy._oa import _design

_design.oaModule.create(design)

_design.oaModule.find(design, name)

绑定状态: 已绑定

Python 调用: _design.oaModule.find(design, name)

This function searches the given design for a module that matches the specified name。 If found, a pointer to the oaModule is returned, otherwise NULL is returned。

参数

• design: The design in which to search for the module。
• name: The name of the module to search。

Python 示例

from oapy._oa import _design

_design.oaModule.find(design, name)

_design.oaModule.embed(design, master)

绑定状态: 已绑定

Python 调用: _design.oaModule.embed(design, master)

This function takes the module hierarchy starting at the top module of the master design and copies it into the design specified by the first argument。 The master design is unchanged, but it will no longer be referenced in hierarchies underneath the destination design。 Any oaModDesignInst of the master in the destination design will be converted to an oaModModuleInst after the embed。 The top module from the master design will not be set as top in the destination design。 If desired, the caller should use oaDesign::setTopModule() after the embed。 An exception is thrown if the master design does not exist, or it is the same as the target design, or it does not contain any module, or if any of the modules to be embedded already exist in the destination design。 When any of these errors occur, the destination will be unchanged。 For more information, see Embedding and Detaching Module Hierarchies in the Programmers Guide。

异常

• oacInvalidModuleEmbedMaster。
• oacEmbedDesignConflictingModuleNames。

Python 示例

from oapy._oa import _design

_design.oaModule.embed(design, master)