oaConstraintParam

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

概览

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

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

详细说明

The oaConstraintParam class represents a parameter used in creating constraint objects。 Constraint parameters are defined by the constraintParamDef and have a value associated with them。 The oaConstraintParam class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.getValue()
✅	obj.getDef()
✅	obj.isOwned()
✅	obj.setValue(value)
✅	obj.destroy()
✅	obj.copy()
✅	obj.copyTo(database)
✅	_base.oaConstraintParam.create(def, value)

方法说明

obj.getValue()

绑定状态: 已绑定

Python 调用: obj.getValue()

This function returns the value for this constraint parameter。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.getValue()

obj.getDef()

绑定状态: 已绑定

Python 调用: obj.getDef()

This function returns the definition for this constraint parameter。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.getDef()

obj.isOwned()

绑定状态: 已绑定

Python 调用: obj.isOwned()

This function returns the boolean indicating whether or not this parameter is owned by a constraint。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.isOwned()

obj.setValue(value)

绑定状态: 已绑定

Python 调用: obj.setValue(value)

This function sets the value for this constraint parameter。

参数

• value: The value to be set on this constraint parameter。

异常

• oacValueAlreadyOwned。
• oacValueNotInSameDatabase。
• oacValueInvalidForConstraintParamDef。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.setValue(value)

obj.destroy()

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this parameter and all of its associated values。 If the parameter is owned by a constraint, an exception is thrown。

异常

• oacCantDestroyOwnedConstraintParam。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.destroy()

obj.copy()

绑定状态: 已绑定

Python 调用: obj.copy()

This function copies this parameter and returns a pointer to the copy。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.copy()

obj.copyTo(database)

绑定状态: 已绑定

Python 调用: obj.copyTo(database)

This function copies this constraint parameter to the database specified。 A pointer to the new constraint parameter is returned。

参数

• database: Database to copy parameter to。

异常

• oacInvalidDatabase。

Python 示例

from oapy._oa import _base

# assume obj is a oaConstraintParam
obj.copyTo(database)

_base.oaConstraintParam.create(def, value)

绑定状态: 已绑定

Python 调用: _base.oaConstraintParam.create(def, value)

This function creates a constraint parameter in the same database as the value specified。

参数

• def: The definition for the constraint parameter。
• value: The value for the parameter。

异常

• oacValueInvalidForConstraintParamDef。

Python 示例

from oapy._oa import _base

_base.oaConstraintParam.create(def, value)