oaModBusNet

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

概览

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

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

详细说明

The oaModBusNet class implements a net in the module domain that represents one or more bits that are associated by a common base name and vector-range specification。 An oaModBusNet object has a corresponding oaModBusNetDef object that manages all oaModBusNet objects that share the same base name。 oaModBusNet, oaOccBusNet , and oaBusNet each represent bus nets on a different kind of master, where in each case the master represents a level of hierarchy in the design。 For oaModBusNet, the master is an oaModule , and each module in a design will have a set of zero or more modBusNets。 For oaOccBusNet , the master is an oaOccurrence 。 For oaBusNet , the master is an oaBlock , and the top block for the design will have a set of zero or more busNets。 Typically, many of the oaBusNets on the top oaBlock have a corresponding oaModBusNet on the top oaModule 。 All of the oaBusNets on the top oaBlock have a corresponding oaOccBusNet on the top oaOccurrence 。 When oaBusNet objects are created in the block domain, the corresponding oaModBusNet objects are automatically created on the top oaModule 。

方法总览

状态	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.oaModBusNet.create(module, baseName, start, stop, step, type=oacSignalSigType, isGlobal=false)`
✅	`_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)`
✅	`_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)`
✅	`_design.oaModBusNet.find(module, baseName, start, stop, step)`
✅	`_design.oaModBusNet.isValidName(module, baseName, start, stop, step)`

方法说明

`obj.getDef()`

绑定状态: 已绑定

Python 调用: obj.getDef()

This function returns the busNetDef for this busNet。

A pointer to an oaModBusNetDef。

Python 示例

from oapy._oa import _design

# assume obj is a oaModBusNet
obj.getDef()

`obj.getStart()`

绑定状态: 已绑定

Python 调用: obj.getStart()

This function returns the starting index for this busNet。

The starting index of this busNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaModBusNet
obj.getStart()

`obj.getStop()`

绑定状态: 已绑定

Python 调用: obj.getStop()

This function returns the ending index for this busNet。

The ending index for this busNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaModBusNet
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 oaModBusNet
obj.getStep()

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this modBusNet。

参数

name: The name of the modBusNet to return。

Python 示例

from oapy._oa import _design

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

`obj.setBaseName(name)`

绑定状态: 已绑定

Python 调用: obj.setBaseName(name)

This function sets the base name of this oaModBusNet object。 The name is also updated for each occurrence the net appears in。

参数

baseName: The new base name to be set for this net。

异常

oacBusNetBaseNameMatchesScalarName。
oacBusNetNameMatchesAutoName。
oacCannotRenameToImplicitBusNet。
oacCannotSetNameOfImplicitNet。
oacCannotSetNameOfNetInBundleNet。
oacImplicitModuleNetExists。
oacImplicitBlockNetExists。
oacInvalidHierNetName。
oacNetExists。
oacNetSetBaseNameConflictsInTerms。
oacNetSetBaseNameConflictsInInstTerms。

Python 示例

from oapy._oa import _design

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

`obj.setRange(start, stop)`

绑定状态: 已绑定

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

This function changes the vector range for this modBusNet。 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 oaModBusNet
obj.setRange(start, stop)

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

Python 示例

from oapy._oa import _design

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

`obj.getName(ns, name)`

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _design

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

`_design.oaModBusNet.create(module, baseName, start, stop, step, type=oacSignalSigType, isGlobal=false)`

绑定状态: 已绑定

Python 调用: _design.oaModBusNet.create(module, baseName, start, stop, step, type=oacSignalSigType, isGlobal=false)

This function creates a busNet with the specified attributes, using an oaVectorBitName as input and creating a single-bit busNet。

参数

module: The module 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。

A pointer to an oaModBusNet。

异常

oacBusNetNameMatchesAutoName。
oacInvalidVectorValue。
oacBusNetBaseNameMatchesScalarName。
oacNetExists。
oacImplicitModuleNetExists。
oacImplicitBlockNetExists。
oacInvalidHierNetName。

Python 示例

from oapy._oa import _design

_design.oaModBusNet.create(module, baseName, start, stop, step, type=oacSignalSigType, isGlobal=false)

`_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)`

绑定状态: 已绑定

Python 调用: _design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)

This function creates a busNet with the specified attributes using an oaVectorName as input and creating a multi-bit busNet。 (Use one of the other create() API functions to create single-bit nets.)。

参数

module: The module 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。

A pointer to an oaModBusNet。

异常

oacBusNetNameMatchesAutoName。
oacInvalidVectorValue。
oacBusNetBaseNameMatchesScalarName。
oacNetExists。
oacImplicitModuleNetExists。
oacImplicitBlockNetExists。
oacInvalidHierNetName。

Python 示例

from oapy._oa import _design

_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)

`_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)`

绑定状态: 已绑定

Python 调用: _design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)

This function creates a single-bit or multi-bit busNet 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 busNet。

参数

module: The module 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。

A pointer to the oaModBusNet created。

异常

oacBusNetNameMatchesAutoName。
oacInvalidVectorValue。
oacBusNetBaseNameMatchesScalarName。
oacNetExists。
oacImplicitModuleNetExists。
oacImplicitBlockNetExists。
oacInvalidHierNetName。

Python 示例

from oapy._oa import _design

_design.oaModBusNet.create(module, name, type=oacSignalSigType, isGlobal=false)

`_design.oaModBusNet.find(module, baseName, start, stop, step)`

绑定状态: 已绑定

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

This function searches the specified module for a busNet with the specified baseName and start, stop, step indices。 The busNet is returned if found。 Otherwise, NULL is returned。

参数

module: The module 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 oaModBusNet。

Python 示例

from oapy._oa import _design

_design.oaModBusNet.find(module, baseName, start, stop, step)

`_design.oaModBusNet.isValidName(module, baseName, start, stop, step)`

绑定状态: 已绑定

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

This function returns a boolean value indicating whether the specified name is valid for a new oaModBusNet in the specified module。

参数

module: The module 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.oaModBusNet.isValidName(module, baseName, start, stop, step)