首页 / design / oaModModuleVectorInst

oaModModuleVectorInst

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

概览

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

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

详细说明

The oaModModuleVectorInst class implements a vector instance of a module master in a module hierarchy。 A vector instance represents several copies of the instance master with a range of index numbers to differentiate them。 An oaModModuleVectorInst object is always in the module domain。 It is an instance of a module as opposed to an oaModVectorInst which would be a vector instance of a design。

方法总览

状态	Python 调用
✅	`obj.getDef()`
✅	`obj.getStart()`
✅	`obj.getStop()`
✅	`obj.getBit(bitIndex)`
✅	`obj.getName(name)`
✅	`obj.setBaseName(baseName)`
✅	`obj.setRange(start, stop)`
✅	`obj.getName(name)`
✅	`obj.getName(ns, name)`
✅	`_design.oaModModuleVectorInst.create(module, master, baseName, start, stop)`
✅	`_design.oaModModuleVectorInst.create(module, masterModuleName, baseName, start, stop)`
✅	`_design.oaModModuleVectorInst.find(module, baseName, start, stop)`
✅	`_design.oaModModuleVectorInst.isValidName(module, baseName, start, stop)`

方法说明

`obj.getDef()`

绑定状态: 已绑定

Python 调用: obj.getDef()

This function returns the module vectorInstDef for this module vectorInst。 The module vectorInstDef is used to access all module vectorInts with the same baseName。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.getDef()

`obj.getStart()`

绑定状态: 已绑定

Python 调用: obj.getStart()

This function returns the start index of this module vectorInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.getStart()

`obj.getStop()`

绑定状态: 已绑定

Python 调用: obj.getStop()

This function returns the stop index of this module vectorInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.getStop()

`obj.getBit(bitIndex)`

绑定状态: 已绑定

Python 调用: obj.getBit(bitIndex)

This function returns a pointer to the vectorInstBit that corresponds to the specified bitIndex bit of this vectorInst。 For example, if this is a vectorInst "i[7:0]" and bitIndex is zero, this function will return the vectorInstBit corresponding to "i[7]"。

参数

bitIndex: Specifies which bit of the instance to return。

A pointer to an oaModModuleVectorInstBit。

异常

oacInvalidBitIndexIntoInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.getBit(bitIndex)

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the vectorName of this modModuleVectorInst。

参数

name: The name of the modModuleVectorInst to return。

Python 示例

from oapy._oa import _design

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

`obj.setBaseName(baseName)`

绑定状态: 已绑定

Python 调用: obj.setBaseName(baseName)

This function changes the base name of this vectorInst。 Exceptions are thrown if the new name is the name of an existing scalar, an arrayInst, or if another vectorInst exists whose indices overlap with this vectorInst, or if the given baseName matches the form of the system-generated scalarInst name。

参数

baseName: The new base name to give this instance。

异常

oacCannotSetNameOfImplicitInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.setBaseName(baseName)

`obj.setRange(start, stop)`

绑定状态: 已绑定

Python 调用: obj.setRange(start, stop)

This function sets the start and stop bit indices of this vectorInst。

参数

start: The new start value to give this instance。
stop: The new stop value to give this instance。

异常

oacInstNameOverlapsOtherInst。
oacCannotSetNameOfImplicitInst。
oacInvalidBusStartStopRange。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInst
obj.setRange(start, stop)

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

Python 示例

from oapy._oa import _design

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

`obj.getName(ns, name)`

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _design

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

`_design.oaModModuleVectorInst.create(module, master, baseName, start, stop)`

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInst.create(module, master, baseName, start, stop)

This function creates an oaModModuleVectorInst object with the specified attributes。 This form of the create specifies the name of the master module so that the master module does not need to be exist to use it。 Exceptions are thrown if the new name is the name of an existing scalarInst, vectorInst, or an arrayInst。

参数

module: The module in which to create the instance。
masterModuleName: The name of the master module。
baseName: The base name for the instance。
start: The start index of the instance range。
stop: The stop index of the instance range。

异常

oacVectorInstNameMatchesAutoName。
oacInstNameExists。
oacInstNameOverlapsOtherInst。
oacInvalidHierInstName。
oacVectorDefInstMustBeModuleInst。
oacVectorDefIsBlockDomainSpecific。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInst.create(module, master, baseName, start, stop)

`_design.oaModModuleVectorInst.create(module, masterModuleName, baseName, start, stop)`

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInst.create(module, masterModuleName, baseName, start, stop)

This function creates an oaModModuleVectorInst object with the specified attributes。 This form of the create specifies the master module so that the master module needs to be exist to use it。 Exceptions are thrown if the new name is the name of an existing scalarInst, vectorInst, or an arrayInst。

参数

module: The parent module in which to create the instance。
master: The master module the instance refers o。
baseName: The base name for the instance。
start: The start index for the instance range。
stop: The stop index for the instance range。

异常

oacModulesNotInSameDesign。
oacVectorInstNameMatchesAutoName。
oacInstNameExists。
oacInstNameOverlapsOtherInst。
oacInvalidHierInstName。
oacVectorDefInstMustBeModuleInst。
oacVectorDefIsBlockDomainSpecific。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInst.create(module, masterModuleName, baseName, start, stop)

`_design.oaModModuleVectorInst.find(module, baseName, start, stop)`

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInst.find(module, baseName, start, stop)

This function searches the specified module for a module vectorInst with the specified name。 The function returns the instance if it finds one。 Otherwise, NULL is returned。

参数

module: The module in which to search for the instance。
baseName: The base name of the instance to look for。
start: The start index of the instance to look for。
stop: The stop index of the instance to look for。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInst.find(module, baseName, start, stop)

`_design.oaModModuleVectorInst.isValidName(module, baseName, start, stop)`

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInst.isValidName(module, baseName, start, stop)

This function returns a boolean value that indicates if the specified baseName, combined with the start and stop values, is a valid new oaModModuleVectorInst in the specified module。

参数

module: The module to check the name against。
baseName: The base name of the instance。
start: The start index of the instance。
stop: The stop index of the instance。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInst.isValidName(module, baseName, start, stop)