首页 / tech / oaPurpose

oaPurpose

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

概览

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

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

详细说明

The oaPurpose class defines a purpose that may be referenced along with a layer when creating physical design data。 A purpose consists of a purpose type, a purpose name, and a purpose number。 Each technology database will have a set of predefined purposes which correspond to the 11 oaPurpose types。 These predefined purposes are always available, and may not be changed nor removed。 This set of predefined purposes consists of the following: Type Name Number oacDrawingPurposeType "drawing" oavPurposeNumberDrawing oacFillPurposeType "fill" oavPurposeNumberFill oacSlotPurposeType "slot" oavPurposeNumberSlot oacOPCSerifPurposeType "OPCSerif" oavPurposeNumberOPCSerif oacOPCAntiSerifPurposeType "OPCAntiSerif" oavPurposeNumberOPCAntiSerif oacAnnotationPurposeType "annotation" oavPurposeNumberAnnotation oacGapFillPurposeType "gapFill" oavPurposeNumberGapFill oacRedundantPurposeType "redundant" oavPurposeNumberRedundant oacAnyPurposeType "oaAny" oavPurposeNumberAny oacNoPurposeType "oaNo" oavPurposeNumberNo oacFillOPCPurposeType "oaFillOPC" oavPurposeNumberFillOPC Additional purposes which are added into the tech database by users are of type oaPurposeTypeEnum::oacDrawingPurposeType 。 The oaPurpose class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	`obj.destroy()`
✅	`obj.getNumber()`
✅	`obj.getName(name)`
✅	`obj.getPurposeType()`
✅	`obj.isReserved()`
✅	`obj.setNumber(number)`
✅	`obj.setName(name)`
✅	`_tech.oaPurpose.create(tech, name, number)`
✅	`_tech.oaPurpose.find(tech, name)`
✅	`_tech.oaPurpose.find(tech, number)`
✅	`_tech.oaPurpose.find(tech, name, local)`
✅	`_tech.oaPurpose.find(tech, number, local)`
✅	`_tech.oaPurpose.get(tech, type)`

方法说明

`obj.destroy()`

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this purpose, removing it from the technology database。 This function unbinds any lpp headers in open designs that are bound to this purpose。

异常

oacCannotDestroyReservedPurpose。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.destroy()

`obj.getNumber()`

绑定状态: 已绑定

Python 调用: obj.getNumber()

This function returns the number of this purpose。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.getNumber()

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this purpose。

Python 示例

from oapy._oa import _tech

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

`obj.getPurposeType()`

绑定状态: 已绑定

Python 调用: obj.getPurposeType()

This function returns the purpose type of this purpose。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.getPurposeType()

`obj.isReserved()`

绑定状态: 已绑定

Python 调用: obj.isReserved()

This function returns true if this purpose is reserved。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.isReserved()

`obj.setNumber(number)`

绑定状态: 已绑定

Python 调用: obj.setNumber(number)

This function sets the number of this purpose to the specified value。 If the specified purpose number exists, an oacPurposeNumberExists exception is thrown。 Note: If this function modifies a purpose number (a new number is set on a purpose, which replaces a previous number set on this purpose), this function will unbind any LPPHeaders that are bound to this purpose in those designs and will bind any LPPHeaders with the new purpose number。

异常

oacPurposeNumberIsReserved。
oacCannotChangeReservedPurpose。
oacPurposeNumberExists。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.setNumber(number)

`obj.setName(name)`

绑定状态: 已绑定

Python 调用: obj.setName(name)

This function sets the name of this purpose to the specified value。

异常

oacCannotChangeReservedPurpose。
oacPurposeNameExists。

Python 示例

from oapy._oa import _tech

# assume obj is a oaPurpose
obj.setName(name)

`_tech.oaPurpose.create(tech, name, number)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.create(tech, name, number)

This function creates a purpose with the specified name and number。 The built-in purposes have a reserved range of purpose numbers, which are from 0xffff0000 to 0xffffffff, inclusive。 Applications cannot create custom purposes that use purpose numbers in this reserved range。 Any purpose number in the set of unsigned four-byte integers, that is not in the reserved range, is a valid purpose number。 For additional information about how OpenAccess manages earlier databases that use purpose numbers in the reserved range, see the Scoping to Purpose section of the Creating and Modeling Process Rule Constraints article of the Programmers Guide。 Note: This function binds any LPPHeaders in open designs that reference the specified purpose number。

异常

oacPurposeNumberIsReserved。
oacPurposeNumberExists。
oacPurposeNameExists。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.create(tech, name, number)

`_tech.oaPurpose.find(tech, name)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.find(tech, name)

This function searches for a purpose with the specified number。 The local argument specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases。 If the purpose is found, a pointer to the purpose object is returned, otherwise NULL is returned。 Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases。

参数

tech: The technology database to search。
number: The purpose number to find。
local: Specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.find(tech, name)

`_tech.oaPurpose.find(tech, number)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.find(tech, number)

This function searches for a purpose with the specified name。 The local argument specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases。 If the purpose is found, a pointer to the purpose object is returned, otherwise NULL is returned。 Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases。

参数

tech: The technology database to search。
name: The name of the purpose to find。
local: Specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.find(tech, number)

`_tech.oaPurpose.find(tech, name, local)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.find(tech, name, local)

This function searches the specified technology database for a purpose with the specified number。 If the specified technology database references other technology databases, those are searched as well and the first matching purpose is returned。 To find a purpose in the current technology database only, refer to the find function that accepts the local argument。 If the function finds the specified purpose, it returns a pointer to the oaPurpose object。 Otherwise, NULL is returned。 Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases。

参数

tech: The technology database to search。
number: The purpose number to find。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.find(tech, name, local)

`_tech.oaPurpose.find(tech, number, local)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.find(tech, number, local)

This function searches the specified technology database for a purpose with the specified name。 If the specified technology database references other technology databases, those are searched as well and the first matching purpose is returned。 To find a purpose in the current technology database only, refer to the find function that accepts the local argument。 If the function finds the specified purpose, it returns a pointer to the oaPurpose object。 Otherwise, NULL is returned。 Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases。

参数

tech: The technology database to search。
name: The name of the purpose to find。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.find(tech, number, local)

`_tech.oaPurpose.get(tech, type)`

绑定状态: 已绑定

Python 调用: _tech.oaPurpose.get(tech, type)

This function returns the reserved purpose of the specified purposeType。

Python 示例

from oapy._oa import _tech

_tech.oaPurpose.get(tech, type)