oaScalarTerm
模块: oapy._oa._design
导入: from oapy._oa import _design
概览
oaScalarTerm 在 oapy 中可用，可通过 _design 模块访问。
本页汇总 oaScalarTerm 当前在 oapy 中可用的 Python 接口。
详细说明
The oaScalarTerm class implements a scalar terminal on an oaBlock 。 Scalar terminals are single bit and have a name without an index。 A scalar terminal must be created on a single-bit net, though the net name does not have to be scalar。 oaScalarTerm objects are always in the block domain。 oaScalarTerms may be physical-only terminals that are only in the block hierarchy, or they can be cross-domain terminals that directly correspond to an oaModScalarTerm in the module domain and an oaOccScalarTerm in the occurrence domain。
方法总览
| 状态 | Python 调用 |
|---|---|
| ✅ | obj.getName(name) |
| ✅ | obj.setName(name) |
| ✅ | obj.getName(name) |
| ✅ | obj.getName(ns, name) |
| ✅ | _design.oaScalarTerm.create(net, name, type=oacInputOutputTermType, view=oacInheritFromTopBlock) |
| ✅ | _design.oaScalarTerm.find(block, name) |
| ✅ | _design.oaScalarTerm.isValidName(block, name) |
方法说明
obj.getName(name)
绑定状态: 已绑定
Python 调用: obj.getName(name)
This function returns the name of this terminal in the name argument。
参数
name: The name of the scalar terminal to return。
Python 示例
from oapy._oa import _design
# assume obj is a oaScalarTerm
obj.getName(name)
obj.setName(name)
绑定状态: 已绑定
Python 调用: obj.setName(name)
This function changes the name of this terminal to the specified name。
参数
name: The new terminal name。
异常
oacCannotSetNameOfImplicitTerm。oacCannotSetNameOfTermInBundleTerm。oacScalarTermNameMatchesBusBaseName。oacTermExists。
Python 示例
from oapy._oa import _design
# assume obj is a oaScalarTerm
obj.setName(name)
obj.getName(name)
绑定状态: 已绑定
Python 调用: obj.getName(name)
Python 示例
from oapy._oa import _design
# assume obj is a oaScalarTerm
obj.getName(name)
obj.getName(ns, name)
绑定状态: 已绑定
Python 调用: obj.getName(ns, name)
Python 示例
from oapy._oa import _design
# assume obj is a oaScalarTerm
obj.getName(ns, name)
_design.oaScalarTerm.create(net, name, type=oacInputOutputTermType, view=oacInheritFromTopBlock)
绑定状态: 已绑定
Python 调用: _design.oaScalarTerm.create(net, name, type=oacInputOutputTermType, view=oacInheritFromTopBlock)
This function creates an oaScalarTerm object on the specified net with the specified attributes。 The function checks the net to verify that it is valid。
参数
net: The bit net to check。name: The name of the scalar terminal to create。type: The terminal type。view: Specifies whether this net is visible in the module domain。
返回
- A pointer to the created scalar terminal。
异常
oacCannotCreateTermWithImplicitNet。oacTermExists。oacTermMemberExists。oacScalarTermNameMatchesBusBaseName。oacImplicitModuleTermExists。oacInvalidHierTermName。oacTermNetMustBeInUniqueOccHier。oacOverridingTermAlreadyExist。oacCannotBlockOverrideNetSignalType。oacPhysOnlyTermNetMustBeInSameOcc。
Python 示例
from oapy._oa import _design
_design.oaScalarTerm.create(net, name, type=oacInputOutputTermType, view=oacInheritFromTopBlock)
_design.oaScalarTerm.find(block, name)
绑定状态: 已绑定
Python 调用: _design.oaScalarTerm.find(block, name)
This function searches the specified block for a scalarTerm with the specified name。 The function returns a pointer to the oaScalarTerm if it is found。 Otherwise, NULL is returned。
参数
block: The block to search。name: The name of the scalar terminal to find。
返回
- A pointer to the scalar terminal, if found; otherwise, NULL is returned。
Python 示例
from oapy._oa import _design
_design.oaScalarTerm.find(block, name)
_design.oaScalarTerm.isValidName(block, name)
绑定状态: 已绑定
Python 调用: _design.oaScalarTerm.isValidName(block, name)
This function returns a boolean value that indicates if specified name is valid for a new oaScalarTerm object on the specified block。 This function also returns true if the name corresponds to a scalarTerm that was hidden but not overridden。
参数
block: The block to search。name: The name of the scalar terminal to return。
Python 示例
from oapy._oa import _design
_design.oaScalarTerm.isValidName(block, name)