首页 / base / oaSimpleName

oaSimpleName

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

概览

oaSimpleName 在 oapy 中可用，可通过 _base 模块访问。

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

详细说明

The oaSimpleName utility class provides a name that can represent either a scalar, vector bit, or vector name。 The oaSimpleName object cannot represent a bundle name。 See the oaScalarName , oaVectorBitName and oaVectorName classes for more specialized name classes In conjunction with oaNameSpace objects, this class facilitates mapping names from one namespace to another。 See the Name Mapping Section of the Programmers Guide for more information about mapping names between different namespaces。 For a more generic object that can represent a scalar, vector bit, vector, or bundle name, use the oaName object instead。 In general, when using oaName and related objects, it is best to choose the object type with closest match to the name。 For example, where an application only uses scalar names, using oaScalarName object is the most performance efficient even though using oaSimpleName would work also。

构造函数

`_base.oaSimpleName()`

obj = _base.oaSimpleName()

`_base.oaSimpleName(nSpace, in)`

obj = _base.oaSimpleName(nSpace, in)

`_base.oaSimpleName(name)`

obj = _base.oaSimpleName(name)

`_base.oaSimpleName(name)`

obj = _base.oaSimpleName(name)

`_base.oaSimpleName(name)`

obj = _base.oaSimpleName(name)

`_base.oaSimpleName(name)`

obj = _base.oaSimpleName(name)

方法总览

状态	Python 调用
✅	`obj.init(nSpace, in)`
✅	`obj.get(nSpace, out)`
✅	`obj.get(out)`
✅	`obj.getBitName(nSpace, bit, out)`
✅	`obj.getType()`
✅	`obj.getRepeat()`
✅	`obj.getNumMembers()`
✅	`obj.getNumBits()`
✅	`obj.getScalar()`
✅	`obj.getVector()`
✅	`obj.getVectorBit()`
✅	`obj.addHierPath(path)`
✅	`obj.addHierPath(path)`
✅	`obj.addHierMem(nSpace, in, len)`
✅	`obj.addHierMem(in)`
✅	`obj.operator=(name)`
✅	`obj.operator=(name)`
✅	`obj.operator=(name)`
✅	`obj.operator=(name)`
✅	`obj.operator[](i)`
✅	`obj.operator==(name)`
✅	`obj.operator==(name)`
✅	`obj.operator==(name)`
✅	`obj.operator==(name)`
✅	`obj.operator!=(name)`
✅	`obj.operator!=(name)`
✅	`obj.operator!=(name)`
✅	`obj.operator!=(name)`

方法说明

`obj.init(nSpace, in)`

绑定状态: 已绑定

Python 调用: obj.init(nSpace, in)

This function initializes the oaSimpleName object by deleting old data previously allocated, then evaluates the input string in the specified namespace, then re-initializes the object to the string specified by in。 This allows reuse of the oaName object to improve application performance。

参数

nSpace: The nameSpace in which to evaluate the string。
in: The input string to evaluate。

异常

oacInvalidNameLength。
oacInvalidNameSyntax。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.init(nSpace, in)

`obj.get(nSpace, out)`

绑定状态: 已绑定

Python 调用: obj.get(nSpace, out)

This function returns this name mapped into the oaNative nameSpace。

参数

out: The string in which to place the mapped name。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.get(nSpace, out)

`obj.get(out)`

绑定状态: 已绑定

Python 调用: obj.get(out)

This function returns this name mapped into the specified nameSpace。 If the name cannot be properly mapped, an empty string is written to out。 An exception is thrown if the specified nameSpace does not support the type of this oaSimpleName。 For information on the names supported in each nameSpace, see Details of OpenAccess Name Spaces 。

参数

nSpace: The nameSpace in which to map this name。
out: The string in which to place the mapped name。

异常

oacVectorNameInvalid。
oacHierNameInvalid。
oacIndexedNameInvalid。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.get(out)

`obj.getBitName(nSpace, bit, out)`

绑定状态: 已绑定

Python 调用: obj.getBitName(nSpace, bit, out)

This function returns the bit name of this oaSimpleName, mapped into the specified oaNameSpace 。

参数

nSpace: The nameSpace to which to map this name。
bit: The bit name to map to the string out。
out: The string in which to place the mapped name。

异常

oacBitNotInRangeForName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getBitName(nSpace, bit, out)

`obj.getType()`

绑定状态: 已绑定

Python 调用: obj.getType()

This function returns the name type for this oaSimpleName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getType()

`obj.getRepeat()`

绑定状态: 已绑定

Python 调用: obj.getRepeat()

This function returns the repeat value for this oaSimpleName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getRepeat()

`obj.getNumMembers()`

绑定状态: 已绑定

Python 调用: obj.getNumMembers()

This function returns the number of hierarchical members in this name object。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getNumMembers()

`obj.getNumBits()`

绑定状态: 已绑定

Python 调用: obj.getNumBits()

This function returns the number of bits this name represents。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getNumBits()

`obj.getScalar()`

绑定状态: 已绑定

Python 调用: obj.getScalar()

This function returns an oaScalarName if this oaSimpleName represents an oaScalarName 。 Otherwise, this function returns NULL。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getScalar()

`obj.getVector()`

绑定状态: 已绑定

Python 调用: obj.getVector()

This function returns an oaVectorName if this oaSimpleName represents an oaVectorName 。 Otherwise, this function returns NULL。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getVector()

`obj.getVectorBit()`

绑定状态: 已绑定

Python 调用: obj.getVectorBit()

This function returns an oaVectorBitName if this oaSimpleName represents an oaVectorBitName 。 Otherwise, this function returns NULL。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.getVectorBit()

`obj.addHierPath(path)`

绑定状态: 已绑定

Python 调用: obj.addHierPath(path)

This function prepends a hierarchical path to this name。 An exception is thrown if this name is empty。

参数

path: The path to add。

异常

oacInvalidName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.addHierPath(path)

`obj.addHierPath(path)`

绑定状态: 已绑定

Python 调用: obj.addHierPath(path)

This function prepends a hierarchical path to this name。 An exception is thrown if this name is empty。

参数

path: The path to add。

异常

oacInvalidName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.addHierPath(path)

`obj.addHierMem(nSpace, in, len)`

绑定状态: 已绑定

Python 调用: obj.addHierMem(nSpace, in, len)

This function adds a hierarchical member to this name, inserting a copy of in after the existing members that represent a partial hierarchical path, and before the last member, which represents the local name。 An exception is thrown if this name is empty。

参数

in: The member to be added。

异常

oacInvalidName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.addHierMem(nSpace, in, len)

`obj.addHierMem(in)`

绑定状态: 已绑定

Python 调用: obj.addHierMem(in)

This function adds the given string as a member of the hierarchical portion of this name。 An exception is thrown if this name is empty。 The in string must not contain any hierarchy delimiters。 Only len characters of in are considered。 An exception is thrown if this name is empty。

参数

nSpace: The nameSpace in which to evaluate the given string。
in: The input string to add to the hierarchy of this name。
len: The length of the specified input string。

异常

oacInvalidName。

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.addHierMem(in)

`obj.operator=(name)`

绑定状态: 已绑定

Python 调用: obj.operator=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator=(name)

`obj.operator=(name)`

绑定状态: 已绑定

Python 调用: obj.operator=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator=(name)

`obj.operator=(name)`

绑定状态: 已绑定

Python 调用: obj.operator=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator=(name)

`obj.operator=(name)`

绑定状态: 已绑定

Python 调用: obj.operator=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator=(name)

`obj.operator[](i)`

绑定状态: 已绑定

Python 调用: obj.operator[](i)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator[](i)

`obj.operator==(name)`

绑定状态: 已绑定

Python 调用: obj.operator==(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator==(name)

`obj.operator==(name)`

绑定状态: 已绑定

Python 调用: obj.operator==(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator==(name)

`obj.operator==(name)`

绑定状态: 已绑定

Python 调用: obj.operator==(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator==(name)

`obj.operator==(name)`

绑定状态: 已绑定

Python 调用: obj.operator==(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator==(name)

`obj.operator!=(name)`

绑定状态: 已绑定

Python 调用: obj.operator!=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator!=(name)

`obj.operator!=(name)`

绑定状态: 已绑定

Python 调用: obj.operator!=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator!=(name)

`obj.operator!=(name)`

绑定状态: 已绑定

Python 调用: obj.operator!=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator!=(name)

`obj.operator!=(name)`

绑定状态: 已绑定

Python 调用: obj.operator!=(name)

Python 示例

from oapy._oa import _base

# assume obj is a oaSimpleName
obj.operator!=(name)