oaModModuleInstHeader

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

概览

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

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

详细说明

The oaModModuleInstHeader class implements an object that contains information common to all the logical instances of a particular master module in a given parent module。 oaModModuleInstHeader objects are scoped within the parent module。 The oaModModuleInstHeader class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.getMasterModule()
✅	obj.getName(name)
✅	obj.getName(ns, name)
✅	obj.isBound()
✅	obj.getInsts(filterFlags=oacInstIterNotImplicit)
✅	_design.oaModModuleInstHeader.find(module, master)
✅	_design.oaModModuleInstHeader.find(module, masterModuleName)

方法说明

obj.getMasterModule()

绑定状态: 已绑定

Python 调用: obj.getMasterModule()

This function attempts to return the master module associated with this module instHeader。 If the instHeader is bound, the master module is returned。 Otherwise, NULL is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleInstHeader
obj.getMasterModule()

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name referenced by this instHeader。 The second version returns the name in the nameSpace specified。

参数

• ns: The namespace for the name。
• name: The master module name。

Python 示例

from oapy._oa import _design

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

obj.getName(ns, name)

绑定状态: 已绑定

Python 调用: obj.getName(ns, name)

This function returns the name referenced by this instHeader。 The second version returns the name in the nameSpace specified。

参数

• name: The master module name。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleInstHeader
obj.getName(ns, name)

obj.isBound()

绑定状态: 已绑定

Python 调用: obj.isBound()

This function returns a boolean value that indicates if this instHeader is bound to its master module。 A bound master means the master is read in and the linkage from the instHeader is established by traversing from an instance to that master。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleInstHeader
obj.isBound()

obj.getInsts(filterFlags=oacInstIterNotImplicit)

绑定状态: 已绑定

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

This function returns a collection of module instances associated with this instHeader。 These instances refer to master modules embedded within the containing design。 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 oaModModuleInstHeader
obj.getInsts(filterFlags=oacInstIterNotImplicit)

_design.oaModModuleInstHeader.find(module, master)

绑定状态: 已绑定

Python 调用: _design.oaModModuleInstHeader.find(module, master)

This function searches the specified module looking for an instHeader with the specified master module name。

参数

• module: The module to be searched。
• masterModuleName: The name of the master module。

Python 示例

from oapy._oa import _design

_design.oaModModuleInstHeader.find(module, master)

_design.oaModModuleInstHeader.find(module, masterModuleName)

绑定状态: 已绑定

Python 调用: _design.oaModModuleInstHeader.find(module, masterModuleName)

This function searches the specified module for an instHeader with the specified master module。 If the specified master is a pCell, the superHeader is returned。

Python 示例

from oapy._oa import _design

_design.oaModModuleInstHeader.find(module, masterModuleName)