oaScalarNet

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

概览

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

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

详细说明

The oaScalarNet class implements a scalar (single-bit) net。

方法总览

状态	Python 调用
✅	`obj.getName(name)`
✅	`obj.setName(name)`
✅	`obj.getName(name)`
✅	`obj.getName(ns, name)`
✅	`_design.oaScalarNet.create(block, name, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)`
✅	`_design.oaScalarNet.create(block, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)`
✅	`_design.oaScalarNet.find(block, name)`
✅	`_design.oaScalarNet.isValidName(block, name)`

方法说明

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this scalar net。

参数

name: The net name to return。

Python 示例

from oapy._oa import _design

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

`obj.setName(name)`

绑定状态: 已绑定

Python 调用: obj.setName(name)

This function changes the name of this net to the specified name。 If the net is hierarchical, the name must be a hierarchical name and the path portion must match that associated with the net。 For example, to change the base name A to base name B in the hierarchical net I1/I2/A, you must specify I1/I2/B as the name。 This function fails if this net is an implicit net or this net is a net in a bundle net。

参数

name: The new local or hierarchical name for the scalar net。

异常

oacCannotSetNameOfImplicitNet。
oacCannotSetNameOfNetInBundleNet。
oacNetExists。
oacScalarNetNameMatchesBusBaseName。
oacHierPathDoesNotExist。
oacHierPathCrossDesign。
oacMismatchedHierPath。

Python 示例

from oapy._oa import _design

# assume obj is a oaScalarNet
obj.setName(name)

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

Python 示例

from oapy._oa import _design

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

`obj.getName(ns, name)`

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _design

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

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

绑定状态: 已绑定

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

This function creates a scalarNet in the specified block with an automatically generated name。 The default name prefix for automatically generated names is N__%d, d referring to a unique integer。

参数

block: The block name。
sigType: The signal type; the default value is oacSignalSigType。
isGlobal: The flag to indicate global net; the default is false。
view: Specifies whether this net is visible in the module domain。

异常

oacScalarNetNameMatchesBusBaseName。

Python 示例

from oapy._oa import _design

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

`_design.oaScalarNet.create(block, sigType=oacSignalSigType, isGlobal=false, view=oacInheritFromTopBlock)`

绑定状态: 已绑定

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

This function verifies that a net with the specified name does not exist and creates an oaScalarNet with the specified name and attributes。 If an oaScalarNet already exists, but it is implicit, this function promotes the net to an explicit state and updates the sigType and isGlobal attributes accordingly。 If the name argument implies a hierarchical name, the path portion of the name must specify an already existing occurrence hierarchy and the path must not extend below the current design boundary。

参数

block: The block name。
name: The local or hierarchical name of the scalar net to create。
sigType: The signal type。
isGlobal: The flag to indicate global net; the default is false。
view: Specifies whether this net is visible in the module domain。

异常

oacNetExists。
oacScalarNetNameMatchesBusBaseName。
oacHierPathDoesNotExist。
oacHierPathCrossDesign。

Python 示例

from oapy._oa import _design

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

`_design.oaScalarNet.find(block, name)`

绑定状态: 已绑定

Python 调用: _design.oaScalarNet.find(block, name)

This function searches the specified block for an oaScalarNet with the specified name。 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。 If the net is not found, NULL is returned。

参数

block: The block to search。
name: The local or hierarchical scalar net name to find。

Python 示例

from oapy._oa import _design

_design.oaScalarNet.find(block, name)

`_design.oaScalarNet.isValidName(block, name)`

绑定状态: 已绑定

Python 调用: _design.oaScalarNet.isValidName(block, name)

This function returns a boolean value that indicates if the specified name is valid for a new oaScalarNet in the specified block。

参数

block: The block to search。
name: The scalar net name to find。

Python 示例

from oapy._oa import _design

_design.oaScalarNet.isValidName(block, name)