oaAreaBoundary

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

概览

oaAreaBoundary 在 oapy 中可用，可通过 _design 模块访问。

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

详细说明

The oaAreaBoundary class represents a generic boundary in a physical block。 This class is used to indicate a region of a block for various purposes defined by a design methodology。 For example, it might be an area that is intended to follow a given design style, or an area with a particular supply voltage。 Area boundaries are named and there can be multiple area boundaries in a given oaBlock 。

方法总览

状态	Python 调用
✅	obj.getName(name)
✅	obj.setName(name)
✅	_design.oaAreaBoundary.create(block, name, points, edgeNames=NULL)
✅	_design.oaAreaBoundary.create(block, points, edgeNames=NULL)
✅	_design.oaAreaBoundary.find(block, name)
✅	_design.oaAreaBoundary.create(block, name, points, edgeNames)
✅	_design.oaAreaBoundary.create(block, points, edgeNames)

方法说明

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function fills in name with the name of this boundary。

参数

• name: The returned name of this boundary。

Python 示例

from oapy._oa import _design

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

obj.setName(name)

绑定状态: 已绑定

Python 调用: obj.setName(name)

This function sets the name of this boundary to the specified name。

参数

• name: The input name of boundary to set。

异常

• oacBoundaryNameExists。

Python 示例

from oapy._oa import _design

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

_design.oaAreaBoundary.create(block, name, points, edgeNames=NULL)

绑定状态: 已绑定

Python 调用: _design.oaAreaBoundary.create(block, name, points, edgeNames=NULL)

This function creates a new area boundary object in the specified block with the specified location and edge names。 The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points。 Note that the number of edge names must be equal to the number of points or an oacBoundaryInvalidEdgeNames exception is thrown。 This form of the create function automatically generates a name for the new boundary, with the format B__%d, where d is an integer that makes this name unique among the boundaries of the block。 If the boundary edgeNames array is empty, the edges are automatically named using the form EDGE_ n, where n starts at zero and increments by one for each edge。 Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function。 Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points。

参数

• block: A pointer to the block in which to create the oaAreaBoundary object。
• points: An oaPointArray of points that describe this boundary。
• edgeNames: A pointer to an array of boundary edge names or an empty array。

异常

• oacBoundaryHasExtraPoints。
• oacBoundaryTooFewPoints。
• oacBoundaryInvalidEdgeNames。

Python 示例

from oapy._oa import _design

_design.oaAreaBoundary.create(block, name, points, edgeNames=NULL)

_design.oaAreaBoundary.create(block, points, edgeNames=NULL)

绑定状态: 已绑定

Python 调用: _design.oaAreaBoundary.create(block, points, edgeNames=NULL)

This function creates a new area boundary object in the specified block with the specified attributes。 With this form of the create() function, the caller supplies a name that must be unique for all boundaries in this block。 if a boundary with the specified name already exists in the specified block, this function throws an exception。 The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points。 For more information on coincident and collinear points, see oaPointArray::compress() 。 Note that the number of edge names must be equal to the number of points or an oacBoundaryInvalidEdgeNames exception is thrown。 If the boundary edgeNames array is empty, the edges are automatically named using the form EDGE_ n, where n starts at zero and increments by one for each edge。 Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function。 Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points。

参数

• block: Block in which to create the area boundary。
• name: Name of the area boundary。
• points: Array of points that describe this boundary。
• edgeNames: Array of boundary edge names or an empty array。

异常

• oacBoundaryHasExtraPoints。
• oacBoundaryTooFewPoints。
• oacBoundaryNameExists。
• oacBoundaryInvalidEdgeNames。

Python 示例

from oapy._oa import _design

_design.oaAreaBoundary.create(block, points, edgeNames=NULL)

_design.oaAreaBoundary.find(block, name)

绑定状态: 已绑定

Python 调用: _design.oaAreaBoundary.find(block, name)

This function searches the specified block for an area boundary with the specified name。 A pointer to the boundary is returned if found, otherwise NULL is returned。

参数

• block: A pointer to the block to search。
• name: The name of boundary to find。

Python 示例

from oapy._oa import _design

_design.oaAreaBoundary.find(block, name)

_design.oaAreaBoundary.create(block, name, points, edgeNames)

绑定状态: 已绑定

Python 调用: _design.oaAreaBoundary.create(block, name, points, edgeNames)

This function is deprecated。 Refer to the create function that takes a reference to an oaStringArray for edgeNames。 This function creates a new area boundary object in the specified block with the specified location and edge names。 The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points。 Note that the number of edge names is assumed to be equal to the number of points。 This form of the create function automatically generates a name for the new boundary, with the format B__%d, where d is an integer that makes this name unique among the boundaries of the block。 If the boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_ n, where n starts at zero and increments by one for each edge。 Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function。 Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points。

参数

• block: A pointer to block in which to create the oaAreaBoundary object。
• points: An oaPointArray of points that describe this boundary。
• edgeNames: A pointer to an array of boundary edge names。

异常

• oacBoundaryHasExtraPoints。
• oacBoundaryTooFewPoints。

Python 示例

from oapy._oa import _design

_design.oaAreaBoundary.create(block, name, points, edgeNames)

_design.oaAreaBoundary.create(block, points, edgeNames)

绑定状态: 已绑定

Python 调用: _design.oaAreaBoundary.create(block, points, edgeNames)

This function is deprecated。 Refer to the create function that takes a reference to an oaStringArray for edgeNames。 This function creates a new area boundary object in the specified block with the specified attributes。 With this form of the create() function, the caller supplies a name that must be unique for all boundaries in this block。 if a boundary with the specified name already exists in the specified block, this function throws an exception。 The specified points pointArray is checked to verify that there are at least three points and no collinear or coincident points。 For more information on coincident and collinear points, see oaPointArray::compress() 。 Note that the number of edge names is assumed to be equal to the number of points。 If the boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_ n, where n starts at zero and increments by one for each edge。 Note: The order of the points actually set on the oaAreaBoundary is not guaranteed to be the same as the order of points passed to the create() function。 Consequently, the order of points returned by a subsequent oaAreaBoundary::getPoints() may be different from the order of points specified in points。

参数

• block: A Pointer to block in which to create the oaAreaBoundary object。
• name: The name of the area boundary。
• points: An oaPointArray of points that describe this boundary。
• edgeNames: A pointer to an array of boundary edge names。

异常

• oacBoundaryHasExtraPoints。
• oacBoundaryTooFewPoints。
• oacBoundaryNameExists。

Python 示例

from oapy._oa import _design

_design.oaAreaBoundary.create(block, points, edgeNames)