oaBusNet

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

概览

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

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

详细说明

The oaBusNet class implements a net that can represent one or more bits that are associated with a common base name and vector range specification。 A busNet has a corresponding busNetDef (refer to oaBusNetDef class) that manages all busNets that share the same base name。 Once a busNet is created, the associated bus net bits are also created as implicit single bit nets if they do not exist already。 Refer to oaNet for a general description of implicit nets。 Bus nets are named by the oaBusName convention, that is, it has a baseName and the start, stop, step value。 A bus net object can be viewed as a collection of single bit logical connections。 An example of oaBusNet--"A[0:6:2]"--It is a bus net consisting of 4 oaBusNetBit objects: A[0] A[2] A[4] A[6]。 The related oaBusNetDef object is what the database use to manage bus nets with the same base name。

方法总览

状态	Python 调用
✅	obj.getDef()
✅	obj.getStart()
✅	obj.getStop()
✅	obj.getStep()
✅	obj.getName(name)
✅	obj.setBaseName(name)
✅	obj.setRange(start, stop)
✅	obj.getName(name)
✅	obj.getName(ns, name)
✅	_design.oaBusNet.create(block, baseName, start, stop, step, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)
✅	_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)
✅	_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)
✅	_design.oaBusNet.find(block, baseName, start, stop, step)
✅	_design.oaBusNet.isValidName(block, baseName, start, stop, step)

方法说明

obj.getDef()

绑定状态: 已绑定

Python 调用: obj.getDef()

This function returns the busNetDef for this busNet。

返回

• A pointer to an oaBusNetDef。

Python 示例

from oapy._oa import _design

# assume obj is a oaBusNet
obj.getDef()

obj.getStart()

绑定状态: 已绑定

Python 调用: obj.getStart()

This function returns the starting index for this oaBusNet。 The bit order of an oaBusNet is implied by the values returned by getStart and getStop。

返回

• The starting index of this busNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaBusNet
obj.getStart()

obj.getStop()

绑定状态: 已绑定

Python 调用: obj.getStop()

This function returns the ending index for this oaBusNet。 The bit order of an oaBusNet is implied by the values returned by getStart and getStop。

返回

• The ending index for this busNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaBusNet
obj.getStop()

obj.getStep()

绑定状态: 已绑定

Python 调用: obj.getStep()

This function returns the step value for this busNet。

返回

• The step value for this busNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaBusNet
obj.getStep()

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this oaBusNet。

参数

• name: The name of the oaBusNet to return。

Python 示例

from oapy._oa import _design

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

obj.setBaseName(name)

绑定状态: 已绑定

Python 调用: obj.setBaseName(name)

This function changes the base name of this oaBusNet。 If the specified name is hierarchical, and the path is identical to the current path name of the busNet, the baseName of the corresponding oaOccNet is set。

参数

• name: The base name for the net。

异常

• oacBusNetBaseNameMatchesScalarName。
• oacBusNetNameMatchesAutoName。
• oacCannotRenameToImplicitBusNet。
• oacCannotSetNameOfImplicitNet。
• oacCannotSetNameOfNetInBundleNet。
• oacNetExists。
• oacNetSetBaseNameConflictsInTerms。
• oacNetSetBaseNameConflictsInInstTerms。
• oacHierPathDoesNotExist。
• oacHierPathCrossDesign。
• oacMismatchedHierPath。

Python 示例

from oapy._oa import _design

# assume obj is a oaBusNet
obj.setBaseName(name)

obj.setRange(start, stop)

绑定状态: 已绑定

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

This function changes the vector range for this busNet。 The new number of bits implied by the specified start and stop bits must match the current number of bits。 This restriction is necessary so that any terminals or instance terminals that are associated with this busNet are not affected。

参数

• start: The starting index of the net。
• stop: The stopping index of the net。

异常

• oacCannotRenameToImplicitBusNet。
• oacCannotSetRangeOfImplicitBus。
• oacCannotSetRangeOfBusInBundleNet。
• oacInvalidBusStartStopRange。
• oacNetExists。
• oacNetSetRangeConflictsWithOtherNets。

Python 示例

from oapy._oa import _design

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

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

Python 示例

from oapy._oa import _design

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

obj.getName(ns, name)

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _design

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

_design.oaBusNet.create(block, baseName, start, stop, step, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

绑定状态: 已绑定

Python 调用: _design.oaBusNet.create(block, baseName, start, stop, step, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

This function creates a oaBusNet with the specified attributes, using an oaVectorBitName as input to create a single-bit oaBusNet。 If the vectorBitName is hierarchical, and the path already exists, and no oaOccNet with this name exists in the specified occurrence, the net is created in the specified occurrence。

参数

• block: The block in which to create the busNet。
• name: The base name and bit index to use to create the busNet。
• sigType: The signal type of the busNet。
• isGlobal: Specifies if this is a global net。
• view: Specifies whether this net is visible in the module domain。

返回

• A pointer to an oaBusNet。

异常

• oacBusNetNameMatchesAutoName。
• oacBusNetBaseNameMatchesScalarName。
• oacNetExists。

Python 示例

from oapy._oa import _design

_design.oaBusNet.create(block, baseName, start, stop, step, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

绑定状态: 已绑定

Python 调用: _design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

This function creates an oaBusNet with the specified attributes using an oaVectorName as input to create a multi-bit oaBusNet。 If the vectorName is hierarchical, and the path already exists, and no oaOccNet with this name exists in the specified occurrence, the net is created in the specified occurrence。 Use one of the other create() functions to create single-bit nets。

参数

• block: The block in which to create the busNet。
• name: The base name, start, stop, and step values to use to create the busNet。
• sigType: The signal type of the busNet。
• isGlobal: Specifies if this is a global busNet。
• view: Specifies whether this net is visible in the module domain。

返回

• A pointer to an oaBusNet。

异常

• oacBusNetNameMatchesAutoName。
• oacBusNetBaseNameMatchesScalarName。
• oacNetExists。

Python 示例

from oapy._oa import _design

_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

绑定状态: 已绑定

Python 调用: _design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

This function creates a single-bit or multi-bit oaBusNet with the specified attributes。 The specified baseName and start, stop, and step indices are first checked to verify they are legal and do not specify an existing oaBusNet。 If the baseName is hierarchical, and the path already exists, and no oaOccNet with this name exists in the specified occurrence, the net is created in the specified occurrence。

参数

• block: The block in which to create the busNet。
• baseName: The base name for the busNet。
• start: The starting index of the busNet。
• stop: The stopping index of the busNet。
• step: The index increment value from start to step; step should be greater than zero。
• sigType: The signal type of the busNet。
• isGlobal: Specifies if this is a global busNet。
• view: Specifies whether this net is visible in the module domain。

返回

• A pointer to the oaBusNet created。

异常

• oacBusNetNameMatchesAutoName。
• oacBusNetBaseNameMatchesScalarName。
• oacNetExists。

Python 示例

from oapy._oa import _design

_design.oaBusNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)

_design.oaBusNet.find(block, baseName, start, stop, step)

绑定状态: 已绑定

Python 调用: _design.oaBusNet.find(block, baseName, start, stop, step)

This function searches the specified block for a oaBusNet with the specified baseName and start, stop, step indices。 The oaBusNet is returned if found。 Otherwise, NULL is returned。 The path portion of the name must specify the path to an existing occurrence in the design。 A hierarchical name is considered an alias that identifies an oaOccNet in the occurrence domain。 If the specified name is hierarchical, the return value is the canonical net in the block domain for the specified alias。

参数

• block: The block in which to find the busNet。
• baseName: The base name for the net。
• start: The starting index of the net。
• stop: The stopping index of the net。
• step: The index increment value from start to step; step should be greater than zero。

返回

• A pointer to the oaBusNet。

Python 示例

from oapy._oa import _design

_design.oaBusNet.find(block, baseName, start, stop, step)

_design.oaBusNet.isValidName(block, baseName, start, stop, step)

绑定状态: 已绑定

Python 调用: _design.oaBusNet.isValidName(block, baseName, start, stop, step)

This function returns a boolean value indicating whether the specified name is valid for a new oaBusNet in the specified block。 False is returned if the specified baseName is hierarchical and an oaOccNet with the specified name already exists, or if an oaOccScalarNet with the same baseName already exists。 False is also returned if the specified baseName is hierarchical, and there is no occurrence with that path name。 These checks are done in the occurrence given by the path portion of the baseName not in the top occurrence。

参数

• block: The block to search。
• baseName: The base bus net name。
• start: The starting index of the net。
• stop: The stopping index of the net。
• step: The index increment value from start to step; step should be greater than zero。

Python 示例

from oapy._oa import _design

_design.oaBusNet.isValidName(block, baseName, start, stop, step)