oaModModuleVectorInstBit

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

概览

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

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

详细说明

The oaModModuleVectorInstBit class implements a single bit of a module vectorInst in a module。 VectorInstBits are automatically created and destroyed as vectorInsts are created or destroyed。 Implicitly-created vectorInstBits cannot be modified to insure consistency with its defining vectorInst。 Explicitly-created vectorInstBits define a unique bit of a vectorInst definition since the bits of a vectorInst are not allowed to overlap with other vectorInsts。

方法总览

状态	Python 调用
✅	obj.getDef()
✅	obj.getBitIndex()
✅	obj.getName(name)
✅	obj.setName(baseName, bitIndex)
✅	obj.getName(name)
✅	obj.getName(ns, name)
✅	_design.oaModModuleVectorInstBit.create(module, master, baseName, bitIndex)
✅	_design.oaModModuleVectorInstBit.create(module, masterName, baseName, bitIndex)
✅	_design.oaModModuleVectorInstBit.find(module, baseName, bitIndex)
✅	_design.oaModModuleVectorInstBit.isValidName(module, baseName, bitIndex)

方法说明

obj.getDef()

绑定状态: 已绑定

Python 调用: obj.getDef()

此函数返回指向 this vectorInstBit 的 vectorInstDef 的指针。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInstBit
obj.getDef()

obj.getBitIndex()

绑定状态: 已绑定

Python 调用: obj.getBitIndex()

This function returns the bitIndex of this vectorInstBit。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInstBit
obj.getBitIndex()

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the vectorName of this modModuleVectorInstBit。

参数

• name: The name fo the modModuleVectorInstBit to return。

Python 示例

from oapy._oa import _design

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

obj.setName(baseName, bitIndex)

绑定状态: 已绑定

Python 调用: obj.setName(baseName, bitIndex)

This function changes the name of this vectorInstBit。 An exception is thrown if the new baseName is the name of an existing scalar or array instance or if a vectorInstBit already exists with the new name。 An exception is also thrown if the new name would overlap with existing vectorInsts。

参数

• baseName: The new base name for this instance。
• bitIndex: The new bit index for this instance。

异常

• oacCannotSetNameOfImplicitInst。

Python 示例

from oapy._oa import _design

# assume obj is a oaModModuleVectorInstBit
obj.setName(baseName, bitIndex)

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

Python 示例

from oapy._oa import _design

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

obj.getName(ns, name)

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _design

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

_design.oaModModuleVectorInstBit.create(module, master, baseName, bitIndex)

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInstBit.create(module, master, baseName, bitIndex)

This function creates an oaModModuleVectorInstBit object with the specified attributes。 The given baseName and bitIndex are checked if they are legal and do not specify an instance that already exists。 This version creates an instance of the master implied by the specified module name。

参数

• module: The module to create the instance in。
• masterName: The name of the master module。
• baseName: The base name to give the instance。
• bitIndex: The bit index to give the instance。

异常

• oacInvalidHierInstName。
• oacVectorInstBitNameMatchesAutoName。
• oacInstNameExists。
• oacInstNameOverlapsOtherInst。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInstBit.create(module, master, baseName, bitIndex)

_design.oaModModuleVectorInstBit.create(module, masterName, baseName, bitIndex)

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInstBit.create(module, masterName, baseName, bitIndex)

This function creates an oaModModuleVectorInstBit object with the specified attributes。 The given baseName and bitIndex are checked if they are legal and do not specify an instance that already exists。 This version creates an instance of the specified master module。

参数

• module: The module to create the instance in。
• master: The master module to instantiate。
• baseName: The base name to give the instance。
• bitIndex: The bit index to give the instance。

异常

• oacInvalidHierInstName。
• oacVectorInstBitNameMatchesAutoName。
• oacInstNameExists。
• oacInstNameOverlapsOtherInst。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInstBit.create(module, masterName, baseName, bitIndex)

_design.oaModModuleVectorInstBit.find(module, baseName, bitIndex)

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInstBit.find(module, baseName, bitIndex)

This function searches the specified module looking for a vectorInstBit with the specified name and bitIndex。 If the instance is found, it is returned; otherwise, NULL is returned。

参数

• module: The module to search。
• baseName: The base name of the instance to look for。
• bitIndex: The bit index of the instance to look for。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInstBit.find(module, baseName, bitIndex)

_design.oaModModuleVectorInstBit.isValidName(module, baseName, bitIndex)

绑定状态: 已绑定

Python 调用: _design.oaModModuleVectorInstBit.isValidName(module, baseName, bitIndex)

This function returns a boolean indicating whether the specified baseName and bitIndex would be valid for an oaModVectorInstBit in the specified module。

参数

• module: The module to search。
• baseName: The base name to validate。
• bitIndex: The bit index to validate。

Python 示例

from oapy._oa import _design

_design.oaModModuleVectorInstBit.isValidName(module, baseName, bitIndex)