首页 / design / oaOccBusTermDef

oaOccBusTermDef

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

概览

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

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

详细说明

The oaOccBusTermDef class defines an object that manages all oaOccBusTerms with the same base name in the module domain。 An oaOccBusTermDef also tracks the least significant and most significant bits of all of its oaOccBusTerms, as well as all of the corresponding oaOccBusTermBits。 A bus definition can be 'sparse' (have missing bits)。 Busses do not have to start or end at zero。 For example, a<22:25> is a legal bus name。 Bus indexes must be non-negative。 The bit order of an explicit oaOccBusTermDef is independent of the order within individual oaOccBusTerms with the same base name。 Verilog requires a single wire declaration for a given base name, and the range of that declaration covers all of the bit indices used by the sub-ranges that correspond to oaOccBusTerms。 oaModBusTermDef , oaOccBusTermDef, and oaBusTermDef each manage the bus terminals on a different kind of master, where in each case the master represents a level of hierarchy in the design。 For oaOccBusTermDef, the master is an oaOccurrence , which corresponds to a unique usage of a module or a block in a design。 Each oaOccurrence in a design will have a set of zero or more occBusTermDefs。 For oaModBusTermDef , the master is an oaModule 。 For oaBusTermDef , the master is an oaBlock , and the top block for the design will have a set of zero or more modBusTermDefs。 Typically, many of the oaBusTermDefs on the top oaBlock have a corresponding oaModBusTermDef on the top oaModule 。 The top oaOccurrence will have a corresponding oaOccBusTermDef for each busTermDef in the union of the terminals between the top oaModule and the top oaBlock 。 The oaOccBusTermDef class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	`obj.getMinIndex()`
✅	`obj.getMaxIndex()`
✅	`obj.getNumBits()`
✅	`obj.getName(name)`
✅	`obj.getName(ns, name)`
✅	`obj.getBitOrder()`
✅	`obj.isImplicit()`
✅	`obj.getBusTerms()`
✅	`obj.getBusTermBits()`
✅	`obj.getBusTerms(filterFlags)`
✅	`obj.getBusTermBits(filterFlags)`
✅	`_design.oaOccBusTermDef.find(occurrence, name)`

方法说明

`obj.getMinIndex()`

绑定状态: 已绑定

Python 调用: obj.getMinIndex()

This function returns the smallest bit number in use for this oaOccBusTermDef object。 This is the smallest index used across all oaOccBusTerms associated with this oaOccBusTermDef object。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getMinIndex()

`obj.getMaxIndex()`

绑定状态: 已绑定

Python 调用: obj.getMaxIndex()

This function returns the largest bit number in use for this oaOccBusTermDef object。 This is the largest index used across all oaOccBusTerms associated with this oaOccBusTermDef object。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getMaxIndex()

`obj.getNumBits()`

绑定状态: 已绑定

Python 调用: obj.getNumBits()

This function returns the number of bits covered by the busses in this oaOccBusTermDef。 The number of bits is equal to abs(maxIndex - minIndex) + 1; it is not necessarily the number of busTermBits present in this busTermDef。 To get the number of busTermBits in this busTermDef, use oaOccBusTermDef::getBusTermBits() .getCount() 。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getNumBits()

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

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

参数

ns: The nameSpace to use when getting the name string。
name: Returns the string name of this oaOccBusTermDef。

Python 示例

from oapy._oa import _design

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

`obj.getName(ns, name)`

绑定状态: 已绑定

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

This function returns the name of this oaOccBusTermDef object。

参数

name: The scalar name in which to return the name of this oaOccBusTermDef。

Python 示例

from oapy._oa import _design

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

`obj.getBitOrder()`

绑定状态: 已绑定

Python 调用: obj.getBitOrder()

This function returns the bitOrder associated with this oaOccBusTermDef object。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getBitOrder()

`obj.isImplicit()`

绑定状态: 已绑定

Python 调用: obj.isImplicit()

This function returns a boolean indicating whether this oaOccBusTermDef was implicitly created or not。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.isImplicit()

`obj.getBusTerms()`

绑定状态: 已绑定

Python 调用: obj.getBusTerms()

This function returns a collection of oaBusTerms in this oaBusTermDef 。

参数

filterFlags: Determines the extent of the contents of the returned collection: oacBusTermIterAll specifies that all bus terms are returned, even those that are hidden。 oacBusTermIterAllNotHidden specifies that the collection shall not include hidden bus terms。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getBusTerms()

`obj.getBusTermBits()`

绑定状态: 已绑定

Python 调用: obj.getBusTermBits()

This function returns a collection of oaBusTermBits in this oaBusTermDef 。

参数

filterFlags: Determines the extent of the contents of the returned collection: oacBusTermBitIterAll specifies that all bus term bits are returned, even those that are hidden。 oacBusTermBitIterAllNotHidden specifies that the collection shall not include hidden bus term bits。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getBusTermBits()

`obj.getBusTerms(filterFlags)`

绑定状态: 已绑定

Python 调用: obj.getBusTerms(filterFlags)

This function returns a collection of oaBusTerms in this oaBusTermDef 。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getBusTerms(filterFlags)

`obj.getBusTermBits(filterFlags)`

绑定状态: 已绑定

Python 调用: obj.getBusTermBits(filterFlags)

This function returns a collection of oaBusTermBits in this oaBusTermDef 。

Python 示例

from oapy._oa import _design

# assume obj is a oaOccBusTermDef
obj.getBusTermBits(filterFlags)

`_design.oaOccBusTermDef.find(occurrence, name)`

绑定状态: 已绑定

Python 调用: _design.oaOccBusTermDef.find(occurrence, name)

This function searches the specified occurrence for an oaBusTermDef with the specified name。 The oaBusTermDef is returned if found。 Otherwise, NULL is returned。

Python 示例

from oapy._oa import _design

_design.oaOccBusTermDef.find(occurrence, name)