首页 / cms / oaCMProtocol

oaCMProtocol

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

概览

oaCMProtocol 在 oapy 中可用，可通过 _cms 模块访问。

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

详细说明

The oaCMProtocol class defines a specific protocol for use by a plug-in。 A protocol has a name, plug-in name, and optional arrays of fixed and modifiable attributes。 The oaCMProtocol class is used to construct an oaCMProtocolArray , which represents the array of oaCMProtocols supported by a plug-in and available for selection by an application。

构造函数

`_cms.oaCMProtocol()`

obj = _cms.oaCMProtocol()

`_cms.oaCMProtocol(nameIn, plugInNameIn)`

obj = _cms.oaCMProtocol(nameIn, plugInNameIn)

`_cms.oaCMProtocol(nameIn, plugInNameIn, fixedAttrsIn, modAttrsIn)`

obj = _cms.oaCMProtocol(nameIn, plugInNameIn, fixedAttrsIn, modAttrsIn)

`_cms.oaCMProtocol(protocolIn)`

obj = _cms.oaCMProtocol(protocolIn)

方法总览

状态	Python 调用
✅	`obj.getName()`
✅	`obj.getPlugInName()`
✅	`obj.getFixedAttrs()`
✅	`obj.getModAttrs()`
✅	`obj.setFixedAttrs(arrayIn)`
✅	`obj.setModAttrs(arrayIn)`
✅	`obj.hasUnsetAttrs()`
✅	`obj.match(protoIn)`
✅	`obj.findAttr(name)`
✅	`obj.operator=(rhs)`
✅	`obj.operator==(rhs)`
✅	`obj.operator!=(rhs)`

方法说明

`obj.getName()`

绑定状态: 已绑定

Python 调用: obj.getName()

This function returns the name of this protocol。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.getName()

`obj.getPlugInName()`

绑定状态: 已绑定

Python 调用: obj.getPlugInName()

This function returns this protocol's plug-in name。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.getPlugInName()

`obj.getFixedAttrs()`

绑定状态: 已绑定

Python 调用: obj.getFixedAttrs()

This function returns this protocol's fixed attributes array。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.getFixedAttrs()

`obj.getModAttrs()`

绑定状态: 已绑定

Python 调用: obj.getModAttrs()

This function returns this protocol's modifiable attributes array。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.getModAttrs()

`obj.setFixedAttrs(arrayIn)`

绑定状态: 已绑定

Python 调用: obj.setFixedAttrs(arrayIn)

This function sets the fixed-attributes array of arrayIn on this protocol。 The arrayIn array must not have any attributes with unset values。

参数

arrayIn: The fixed-attributes array to set on this protocol。

异常

oacCMUnsetAttributesNotAllowed。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.setFixedAttrs(arrayIn)

`obj.setModAttrs(arrayIn)`

绑定状态: 已绑定

Python 调用: obj.setModAttrs(arrayIn)

This function sets the modifiable-attributes array of arrayIn on this protocol。

参数

arrayIn: The modifiable-attributes array to set on this protocol。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.setModAttrs(arrayIn)

`obj.hasUnsetAttrs()`

绑定状态: 已绑定

Python 调用: obj.hasUnsetAttrs()

Returns true if at least one of the modifiable attributes of this protocol does not have its value set。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.hasUnsetAttrs()

`obj.match(protoIn)`

绑定状态: 已绑定

Python 调用: obj.match(protoIn)

This function matches this protocol to the specified protoIn and returns true if their names, plug-in names, fixed attribute names and values, and the number and names of modifiable attributes are the same。 It returns false otherwise。

参数

protoIn: The protocol to match with this protocol。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.match(protoIn)

`obj.findAttr(name)`

绑定状态: 已绑定

Python 调用: obj.findAttr(name)

This function finds the attribute that matches the specified name。 First, the fixed attribute array is searched; then the modifiable attribute array is searched。 NULL is returned if the named attributed is not found in either array。

参数

name: The name of attribute to find。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.findAttr(name)

`obj.operator=(rhs)`

绑定状态: 已绑定

Python 调用: obj.operator=(rhs)

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.operator=(rhs)

`obj.operator==(rhs)`

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.operator==(rhs)

`obj.operator!=(rhs)`

绑定状态: 已绑定

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

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMProtocol
obj.operator!=(rhs)