oaOccInstHeader

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

概览

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

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

详细说明

The oaOccInstHeader class implements an object that contains information common to all the instances of a particular master design in a given parent occurrence。 For instances of Pcells, there are two kinds of instHeaders: SuperHeaders represent all of the instances of a Pcell master, regardless of parameter settings SubHeaders represent all of the instances that have one specific set of parameter values Every instance of a Pcell has exactly one subHeader, which, in turn, has exactly one superHeader。 InstHeaders for instances that are not Pcells are neither subheaders nor superheaders。 The oaOccInstHeader class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.getMaster()
✅	obj.getLibName(libName)
✅	obj.getCellName(cellName)
✅	obj.getViewName(viewName)
✅	obj.getLibName(ns, libName)
✅	obj.getCellName(ns, cellName)
✅	obj.getViewName(ns, viewName)
✅	obj.getParams(params)
✅	obj.getAllParams(params)
✅	obj.getSuperHeader()
✅	obj.isBound()
✅	obj.isSuperHeader()
✅	obj.isSubHeader()
✅	obj.getInstHeader()
✅	obj.getModInstHeader()
✅	obj.getInsts(filterFlags=oacInstIterNotImplicit, parentOcc=NULL)
✅	obj.getSubHeaders()

方法说明

obj.getMaster()

绑定状态: 已绑定

Python 调用: obj.getMaster()

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

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getMaster()

obj.getLibName(libName)

绑定状态: 已绑定

Python 调用: obj.getLibName(libName)

This function returns the library name of the master oaDesign referenced by this occInstHeader。

参数

• ns: The namespace in which to return the library name。
• libName: The returned library name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getLibName(libName)

obj.getCellName(cellName)

绑定状态: 已绑定

Python 调用: obj.getCellName(cellName)

This function returns the cell name of the master oaDesign referenced by this occInstHeader。

参数

• ns: The namespace in which to return the cell name。
• cellName: The returned cell name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getCellName(cellName)

obj.getViewName(viewName)

绑定状态: 已绑定

Python 调用: obj.getViewName(viewName)

This function returns the view name of the master oaDesign referenced by this occInstHeader。

参数

• ns: The namespace in which to return the view name。
• viewName: The returned view name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getViewName(viewName)

obj.getLibName(ns, libName)

绑定状态: 已绑定

Python 调用: obj.getLibName(ns, libName)

This function returns the library name of the master oaDesign referenced by this occInstHeader。

参数

• libName: The returned library name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getLibName(ns, libName)

obj.getCellName(ns, cellName)

绑定状态: 已绑定

Python 调用: obj.getCellName(ns, cellName)

This function returns the cell name of the master oaDesign referenced by this occInstHeader。

参数

• cellName: The returned cell name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getCellName(ns, cellName)

obj.getViewName(ns, viewName)

绑定状态: 已绑定

Python 调用: obj.getViewName(ns, viewName)

This function returns the view name of the master oaDesign referenced by this occInstHeader。

参数

• viewName: The returned view name。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getViewName(ns, viewName)

obj.getParams(params)

绑定状态: 已绑定

Python 调用: obj.getParams(params)

This function fills out params with the parameters associated with this instHeader。 This call only returns the non-default parameters that were specified during creation or through calls to setParams() on the instances。 If this instHeader is not associated with a Pcell master or uses all default parameters, params will have a numParams of zero。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getParams(params)

obj.getAllParams(params)

绑定状态: 已绑定

Python 调用: obj.getAllParams(params)

This function fills out params with the parameters associated with this instHeader and the parameters associated with the superMaster。 If this instHeader is not associated with parameters, params will have a numParams value of zero。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getAllParams(params)

obj.getSuperHeader()

绑定状态: 已绑定

Python 调用: obj.getSuperHeader()

This function returns the superHeader of this instHeader。 The function returns NULL if it is not a subHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getSuperHeader()

obj.isBound()

绑定状态: 已绑定

Python 调用: obj.isBound()

This function returns a boolean value that indicates if this instHeader is bound to its master design。 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。 Since there is only one occInstHeader for each distinct master design, shared by all occInsts within an instantiating design (regardless of which occurrence each occInst is in), this function does not indicate that there is a bound oaOccurrence for the master design。 To check whether there is a bound occurrence for a given occInst, use oaOccInst::isBound() 。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.isBound()

obj.isSuperHeader()

绑定状态: 已绑定

Python 调用: obj.isSuperHeader()

This function returns a boolean value that indicates if this instHeader is a superHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.isSuperHeader()

obj.isSubHeader()

绑定状态: 已绑定

Python 调用: obj.isSubHeader()

This function returns a boolean value that indicates if this instHeader is a subHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.isSubHeader()

obj.getInstHeader()

绑定状态: 已绑定

Python 调用: obj.getInstHeader()

This function returns the block domain object referenced by this occurrence instHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getInstHeader()

obj.getModInstHeader()

绑定状态: 已绑定

Python 调用: obj.getModInstHeader()

This function returns the module domain object referenced by this occurrence instHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getModInstHeader()

obj.getInsts(filterFlags=oacInstIterNotImplicit, parentOcc=NULL)

绑定状态: 已绑定

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

This function returns a collection of instances associated with this instHeader。 The filter flag bits are defined below and may be logically OR'd together to refine the contents of the collection。 If the optional occurrence is specified, the collection contains only the occInsts which directly belong to that occurrence as parent。

参数

• 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。
• occ: Specifies that the collection should only contain those instances where the occurrence is the parent。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getInsts(filterFlags=oacInstIterNotImplicit, parentOcc=NULL)

obj.getSubHeaders()

绑定状态: 已绑定

Python 调用: obj.getSubHeaders()

This function returns a collection of subHeaders in this superHeader。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccInstHeader
obj.getSubHeaders()