oaDMContainer

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

概览

oaDMContainer 在 oapy 中可用，可通过 _dm 模块访问。

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

详细说明

The oaDMContainer class is the base for all classes that are file containers。

方法总览

状态	Python 调用
✅	obj.getDMFiles()
✅	obj.getVCStatus(depth, mask=oacVCStatusAll)
✅	obj.getVCStatus(mask=oacVCStatusAll)

方法说明

obj.getDMFiles()

绑定状态: 已绑定

Python 调用: obj.getDMFiles()

This function constructs and returns a collection of files in the container。 This function requires access to the library associated with this object (through a call to oaLib::getAccess )。 An oacLibAccessDenied exception is thrown if access to the library does not exist。 For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide。

异常

• oacInvalidContainer。
• oacLibAccessDenied。

Python 示例

from oapy._oa import _dm

# assume obj is a oaDMContainer
obj.getDMFiles()

obj.getVCStatus(depth, mask=oacVCStatusAll)

绑定状态: 已绑定

Python 调用: obj.getVCStatus(depth, mask=oacVCStatusAll)

This function is only active when a Version Control system is in place for the library this object is in。 It gets the version control status of the children of this container。 Use "depth" to control how far down the hierarchy to traverse。

参数

• depth: this parameter is used to control the depth that this function will go in the hierarchy when applying this operation。 The enum values have the following meanings: oacFileVCQueryDepth: query only the immediate children files of this container oacCellVCQueryDepth: stop the query at the Cell level, not including "cell files" oacViewVCQueryDepth: stop the query at the View level, not including "view files" oacCellViewVCQueryDepth: stop the query at the CellView level, not including "cellView" files oacCellViewFileVCQueryDepth: stop the query at the CellView file level。 This is currently the lowest level oacMaxQueryDepth: query to the bottom of the hierarchy。
• mask: this parameter is used to limit the status bits being retrieved。 Some types of status are more expensive to discover than others; use this mask to optimize performance。

异常

• oacLibAccessDenied。

Python 示例

from oapy._oa import _dm

# assume obj is a oaDMContainer
obj.getVCStatus(depth, mask=oacVCStatusAll)

obj.getVCStatus(mask=oacVCStatusAll)

绑定状态: 已绑定

Python 调用: obj.getVCStatus(mask=oacVCStatusAll)

Python 示例

from oapy._oa import _dm

# assume obj is a oaDMContainer
obj.getVCStatus(mask=oacVCStatusAll)