oaCMObjectRefTbl

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

概览

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

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

详细说明

The oaCMObjectRefTbl class contains contains all the reference objects for a change set。

构造函数

_cms.oaCMObjectRefTbl(database)

obj = _cms.oaCMObjectRefTbl(database)

方法总览

状态	Python 调用
✅	obj.find(obj)
✅	obj.onPassivate(ref)
✅	obj.onActivate(ref)
✅	obj.getDatabase()
✅	obj.begin()
✅	obj.end()
✅	obj.cleanup(timeStamp)

方法说明

obj.find(obj)

绑定状态: 已绑定

Python 调用: obj.find(obj)

此函数返回指向指定对象的 oaCMObjectRef 的智能指针。

参数

• obj: A pointer to the object for which to find the oaCMObjectRef 。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.find(obj)

obj.onPassivate(ref)

绑定状态: 已绑定

Python 调用: obj.onPassivate(ref)

This function is called when the specified reference ref is passivated。

参数

• ref: The oaCMObjectRef to passivate。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.onPassivate(ref)

obj.onActivate(ref)

绑定状态: 已绑定

Python 调用: obj.onActivate(ref)

This function is called when the specified reference ref is activated。

参数

• ref: The oaCMObjectRef to activate。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.onActivate(ref)

obj.getDatabase()

绑定状态: 已绑定

Python 调用: obj.getDatabase()

This function returns a smart pointer to the database for this oaCMObjectRef 。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.getDatabase()

obj.begin()

绑定状态: 已绑定

Python 调用: obj.begin()

This function returns a constant iterator that points to the first oaCMObjectRef in the table。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.begin()

obj.end()

绑定状态: 已绑定

Python 调用: obj.end()

This function returns a constant iterator that points to the last oaCMObjectRef in the table。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.end()

obj.cleanup(timeStamp)

绑定状态: 已绑定

Python 调用: obj.cleanup(timeStamp)

This function removes the references that are older than timeStamp。

参数

• timeStamp: The timestamp indicating when to begin the clean-up。

Python 示例

from oapy._oa import _cms

# assume obj is a oaCMObjectRefTbl
obj.cleanup(timeStamp)