oaCellDMData
模块: oapy._oa._dm
导入: from oapy._oa import _dm
概览
oaCellDMData 在 oapy 中可用，可通过 _dm 模块访问。
本页汇总 oaCellDMData 当前在 oapy 中可用的 Python 接口。
详细说明
oaCellDMData objects represent database objects that can be associated with a DM cell and can be used to persistently store properties ( oaProp objects), groups ( oaGroup objects), group members ( oaGroupMember objects) and application objects (see oaAppObject .)。
方法总览
| 状态 | Python 调用 |
|---|---|
| ✅ | obj.getCellName(cellName) |
| ✅ | obj.getCellName(ns, cellName) |
| ✅ | _dm.oaCellDMData.open(libName, cellName, mode) |
| ✅ | _dm.oaCellDMData.recover(libName, cellName, saveRecoverType) |
| ✅ | _dm.oaCellDMData.find(libName, cellName) |
| ✅ | _dm.oaCellDMData.exists(libName, cellName) |
| ✅ | _dm.oaCellDMData.exists(libName, cellName, saveRecoverType) |
| ✅ | _dm.oaCellDMData.destroy(libName, cellName) |
| ✅ | _dm.oaCellDMData.destroy(libName, cellName, saveRecoverType) |
方法说明
obj.getCellName(cellName)
绑定状态: 已绑定
Python 调用: obj.getCellName(cellName)
This function returns the cell name for this oaCellDMData object in the specified nameSpace。
参数
ns: input parameter - the name space in which to return the cell name。cellName: the returned oaString cell name。
异常
oacInvalidCell。oacDMDataCannotGetReadAccess。
Python 示例
from oapy._oa import _dm
# assume obj is a oaCellDMData
obj.getCellName(cellName)
obj.getCellName(ns, cellName)
绑定状态: 已绑定
Python 调用: obj.getCellName(ns, cellName)
This function returns the cell name for this oaCellDMData object。
参数
cellName: the returned oaScalarName cell name。
异常
oacInvalidCell。
Python 示例
from oapy._oa import _dm
# assume obj is a oaCellDMData
obj.getCellName(ns, cellName)
_dm.oaCellDMData.open(libName, cellName, mode)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.open(libName, cellName, mode)
This function attempts to open the oaCellDMData object for the cell with the specified name in the specified library with the specified mode。 If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaCellDMData does not exist, it will be created。 If the specified mode is a read-access mode ('r'ead-only mode) and the oaCellDMData does not exist, an oacDMDataDoesNotExist exception will be thrown。 If successful, a pointer to the CellDMData object is returned。
参数
libName: The name of the library to use。cellName: The name of the cell whose DMData is to be opened。mode: The mode to use to open the DMData。
异常
oacOpenUndefinedModeDMData。oacLibNotFound。oacCellNotFound。oacDMDataCannotGetReadAccess。oacDMDataHasReadNeedWriteAccess。oacDMDataCannotGetWriteAccess。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.open(libName, cellName, mode)
_dm.oaCellDMData.recover(libName, cellName, saveRecoverType)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.recover(libName, cellName, saveRecoverType)
This function attempts to recover the DM data for the given library and cell name with the specified oasSaveRecoverType。 If successful, a pointer to the oaCellDMData object is returned。
参数
libName: The name of the library。cellName: The name of the cell。saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。
异常
oacLibNotFound。oacReadLibAccess。oacCellNotFound。oacSaveRecoverDMDataFileAlreadyOpened。oacOpenOnDMDataBeingPurged。oacDMDataDoesNotExist。oacSaveRecoverFileDoesNotExistOnDisk。oacInterfaceException。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.recover(libName, cellName, saveRecoverType)
_dm.oaCellDMData.find(libName, cellName)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.find(libName, cellName)
This function attempts to find an open DM data for the given library。 If successful, a pointer to the DMData object is returned; otherwise, NULL is returned。
参数
libName: The name of the library in which the lookup will happen。cellName: The name of the cell whose CellDMData is to be found。
异常
oacDMDataCannotGetReadAccess。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.find(libName, cellName)
_dm.oaCellDMData.exists(libName, cellName)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.exists(libName, cellName)
This function returns a boolean that indicates whether the specified oaSaveRecoverType file exists on-disk。
参数
libName: The name of the library to check。cellName: The name of the cell to check。saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.exists(libName, cellName)
_dm.oaCellDMData.exists(libName, cellName, saveRecoverType)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.exists(libName, cellName, saveRecoverType)
This function checks whether there is a DMData open for the given library, or if a DMData file exists on disk with a non-zero size。
参数
libName: The name of the library to check。cellName: The name of the cell to checked。
异常
oacDMDataCannotGetReadAccess。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.exists(libName, cellName, saveRecoverType)
_dm.oaCellDMData.destroy(libName, cellName)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.destroy(libName, cellName)
This function attempts to remove the specified oaSaveRecoverType file from disk。 It throws an exception if this file is not found on disk。
参数
libName: The name of the library。cellName: The name of the cell for which the oaCellDMData is to be destroyed。saveRecoverType: Either oacAutoSaveType or oacCriticalSaveType。
异常
oacLibNotFound。oacDestroyDMDataDoesNotExist。oacSaveRecoverFileDoesNotExistOnDisk。oacInterfaceException。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.destroy(libName, cellName)
_dm.oaCellDMData.destroy(libName, cellName, saveRecoverType)
绑定状态: 已绑定
Python 调用: _dm.oaCellDMData.destroy(libName, cellName, saveRecoverType)
This function attempts to remove the dmData from disk。 It throws an exception if the dmData is currently open or if the dmData cannot be found on disk。
参数
libName: The name of the library。cellName: The name of the cell whose CellDMData is to be destroyed。
异常
oacLibNotFound。oacDestroyDMDataDoesNotExist。oacDMDataHasReadNeedWriteAccess。oacDMDataCannotGetWriteAccess。oacDestroyDMDataOpen。oacDestroyDMDataDoesNotExist。
Python 示例
from oapy._oa import _dm
_dm.oaCellDMData.destroy(libName, cellName, saveRecoverType)