首页 / design / oaClusterBoundary

oaClusterBoundary

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

概览

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

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

详细说明

The oaClusterBoundary class indicates an area in which the contents of a specific cluster should be placed。 Each oaClusterBoundary is attached to a specific oaCluster object。 An oaCluster may have multiple oaClusterBoundary objects attached to it, in which case the contents of the cluster may be placed in any of its boundaries。 An oaClusterBoundary must have a unique name with respect to all Boundaries in a given design。

方法总览

状态	Python 调用
✅	`obj.getCluster()`
✅	`obj.getName(name)`
✅	`obj.setName(name)`
✅	`_design.oaClusterBoundary.create(cluster, name, points, edgeNames=NULL)`
✅	`_design.oaClusterBoundary.create(cluster, points, edgeNames=NULL)`
✅	`_design.oaClusterBoundary.find(cluster, name)`
✅	`_design.oaClusterBoundary.create(cluster, name, points, edgeNames)`
✅	`_design.oaClusterBoundary.create(cluster, points, edgeNames)`

方法说明

`obj.getCluster()`

绑定状态: 已绑定

Python 调用: obj.getCluster()

This function returns the cluster of this boundary。

Python 示例

from oapy._oa import _design

# assume obj is a oaClusterBoundary
obj.getCluster()

`obj.getName(name)`

绑定状态: 已绑定

Python 调用: obj.getName(name)

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

Python 示例

from oapy._oa import _design

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

`obj.setName(name)`

绑定状态: 已绑定

Python 调用: obj.setName(name)

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

异常

oacBoundaryNameExists。

Python 示例

from oapy._oa import _design

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

`_design.oaClusterBoundary.create(cluster, name, points, edgeNames=NULL)`

绑定状态: 已绑定

Python 调用: _design.oaClusterBoundary.create(cluster, name, points, edgeNames=NULL)

This function creates a new cluster boundary object in the specified cluster with the specified attributes。 A name for the new cluster boundary is automatically generated, with the default name prefix B__%d, d referring to a unique integer。 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。 Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points。

参数

cluster: The cluster in which to create the boundary。
points: The array of points。
edgeNames: The array of edge names or an empty array。

异常

oacBoundaryHasExtraPoints。
oacBoundaryTooFewPoints。
oacBoundaryInvalidEdgeNames。

Python 示例

from oapy._oa import _design

_design.oaClusterBoundary.create(cluster, name, points, edgeNames=NULL)

`_design.oaClusterBoundary.create(cluster, points, edgeNames=NULL)`

绑定状态: 已绑定

Python 调用: _design.oaClusterBoundary.create(cluster, points, edgeNames=NULL)

This function creates a new cluster boundary object in the specified cluster with the specified attributes。 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。 Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points。

参数

cluster: The cluster in which to create the boundary。
name: The name for the boundary。
points: The array of points。
edgeNames: The array of edge names or an empty array。

异常

oacBoundaryNameExists。
oacBoundaryHasExtraPoints。
oacBoundaryTooFewPoints。
oacBoundaryInvalidEdgeNames。

Python 示例

from oapy._oa import _design

_design.oaClusterBoundary.create(cluster, points, edgeNames=NULL)

`_design.oaClusterBoundary.find(cluster, name)`

绑定状态: 已绑定

Python 调用: _design.oaClusterBoundary.find(cluster, name)

This function searches the design of the specified cluster for a cluster boundary with the specified name。 The boundary is returned if found。 Otherwise, NULL is returned。

Python 示例

from oapy._oa import _design

_design.oaClusterBoundary.find(cluster, name)

`_design.oaClusterBoundary.create(cluster, name, points, edgeNames)`

绑定状态: 已绑定

Python 调用: _design.oaClusterBoundary.create(cluster, 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 cluster boundary object in the specified cluster with the specified attributes。 A name for the new cluster boundary is automatically generated, with the default name prefix B__%d, d referring to a unique integer。 Note that the number of edge names is assumed to be equal to the number of points。 If boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_ n, where n starts at zero and increments by one。 Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points。

异常

oacBoundaryHasExtraPoints。
oacBoundaryTooFewPoints。

Python 示例

from oapy._oa import _design

_design.oaClusterBoundary.create(cluster, name, points, edgeNames)

`_design.oaClusterBoundary.create(cluster, points, edgeNames)`

绑定状态: 已绑定

Python 调用: _design.oaClusterBoundary.create(cluster, 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 cluster boundary object in the specified cluster with the specified attributes。 Note that the number of edge names is assumed to be equal to the number of points。 If boundary edgeNames are not supplied, the edges are automatically named, using the form EDGE_ n, where n starts at zero and increments by one。 Note: The order of the points actually set on the oaClusterBoundary 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 oaClusterBoundary::getPoints() may be different from the order of points specified in points。

异常

oacBoundaryNameExists。
oacBoundaryHasExtraPoints。
oacBoundaryTooFewPoints。

Python 示例

from oapy._oa import _design

_design.oaClusterBoundary.create(cluster, points, edgeNames)