oaDerivedLayerParamDef

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

概览

oaDerivedLayerParamDef 在 oapy 中可用，可通过 _tech 模块访问。

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

详细说明

The oaDerivedLayerParamDef object specifies a definition for a particular derived layer parameter。 The definition contains a name and the valueType that is allowed for the parameter。 The names for derived layer parameter definitions must be unique。 The oaDerivedLayer ParamDef class can be observed by deriving from oaObserver。 See Uniqueness of Session Objects for information about the requirement that session objects be unique。

方法总览

状态	Python 调用
✅	obj.getName(name)
✅	obj.getValueType()
✅	obj.isBuiltIn()
✅	obj.destroy()
✅	obj.remove(tech)
✅	_tech.oaDerivedLayerParamDef.create(name, valueType)
✅	_tech.oaDerivedLayerParamDef.get(type)
✅	_tech.oaDerivedLayerParamDef.find(name)

方法说明

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of the derivedLayerParamDef。

参数

• name: The constant oaString name of the oaDerivedLayerParamDef。

Python 示例

from oapy._oa import _tech

# assume obj is a oaDerivedLayerParamDef
obj.getName(name)

obj.getValueType()

绑定状态: 已绑定

Python 调用: obj.getValueType()

This function returns the valueType of the derivedLayerParamDef。

Python 示例

from oapy._oa import _tech

# assume obj is a oaDerivedLayerParamDef
obj.getValueType()

obj.isBuiltIn()

绑定状态: 已绑定

Python 调用: obj.isBuiltIn()

This function returns true if this derived layer param def is a built-in def。

Python 示例

from oapy._oa import _tech

# assume obj is a oaDerivedLayerParamDef
obj.isBuiltIn()

obj.destroy()

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys the derivedLayerParamDef。 If any database currently references this definition, or if this is a built-in definition, an exception is thrown。 An exception is also thrown if this function is called when undo is enabled on any of the current in-memory design or tech databases。

异常

• oacUnableToDestroyBuiltInType。
• oacDerivedLayerParamDefHasReference。
• oacCannotDestroyDefUndo。

Python 示例

from oapy._oa import _tech

# assume obj is a oaDerivedLayerParamDef
obj.destroy()

obj.remove(tech)

绑定状态: 已绑定

Python 调用: obj.remove(tech)

This function removes the derivedLayerParamDef from the specified tech database。 If there are derived layers in the database that reference this definition, an oacDerivedLayerParamDefHasReference exception is thrown。

参数

• tech: The technology database containing the definition。

异常

• oacDerivedLayerParamDefHasReference。

Python 示例

from oapy._oa import _tech

# assume obj is a oaDerivedLayerParamDef
obj.remove(tech)

_tech.oaDerivedLayerParamDef.create(name, valueType)

绑定状态: 已绑定

Python 调用: _tech.oaDerivedLayerParamDef.create(name, valueType)

This function creates a new oaDerivedLayerParamDef。 It is an error if the name of the derivedLayerParamDef already exists, and it is an error if the type specified is not an oaValue subtype。

参数

• name: The constant oaString name for this oaDerivedLayerParamDef。
• valueType: An oaValue subtype。

异常

• oacDerivedLayerParamDefExists。
• oacInvalidValueType。

Python 示例

from oapy._oa import _tech

_tech.oaDerivedLayerParamDef.create(name, valueType)

_tech.oaDerivedLayerParamDef.get(type)

绑定状态: 已绑定

Python 调用: _tech.oaDerivedLayerParamDef.get(type)

This function returns the built in derived layer parameter definition of the type specified。

参数

• type: An oaDerivedLayerParamType enum。

Python 示例

from oapy._oa import _tech

_tech.oaDerivedLayerParamDef.get(type)

_tech.oaDerivedLayerParamDef.find(name)

绑定状态: 已绑定

Python 调用: _tech.oaDerivedLayerParamDef.find(name)

This function finds the derived layer parameter definition by name。 If the definition is not found, NULL is returned。

参数

• name: The name of the derived layer parameter definition to find。

Python 示例

from oapy._oa import _tech

_tech.oaDerivedLayerParamDef.find(name)