oaCluster

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

概览

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

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

详细说明

The oaCluster class implements a cluster object that is used to associate a group of instances and boundaries within a block。 Clusters can be hierarchical。 The oaCluster class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.destroy()
✅	obj.getParent()
✅	obj.getName(name)
✅	obj.getClusterType()
✅	obj.setName(name)
✅	obj.setClusterType(type)
✅	obj.isParent()
✅	obj.addToCluster(cluster)
✅	obj.removeFromCluster()
✅	obj.getClusters()
✅	obj.getInsts()
✅	obj.getBoundaries()
✅	obj.getBlockagesOwnedBy()
✅	_design.oaCluster.create(block, name, type)
✅	_design.oaCluster.find(block, name)

方法说明

obj.destroy()

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this cluster, removing it from the database。 All instances in this cluster remain intact。 If there are boundaries associated with this cluster, the boundaries are destroyed。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.destroy()

obj.getParent()

绑定状态: 已绑定

Python 调用: obj.getParent()

This function returns the parent cluster of this cluster if this cluster is a child cluster。 Otherwise, NULL is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getParent()

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function fills out name with the name of this cluster。

参数

• name: The string in which the cluster name is returned。

Python 示例

from oapy._oa import _design

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

obj.getClusterType()

绑定状态: 已绑定

Python 调用: obj.getClusterType()

This function returns the clusterType of this cluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getClusterType()

obj.setName(name)

绑定状态: 已绑定

Python 调用: obj.setName(name)

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

参数

• name: The new name for this cluster。

异常

• oacClusterNameExists。

Python 示例

from oapy._oa import _design

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

obj.setClusterType(type)

绑定状态: 已绑定

Python 调用: obj.setClusterType(type)

This function sets the cluster type to the specified value。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.setClusterType(type)

obj.isParent()

绑定状态: 已绑定

Python 调用: obj.isParent()

This function returns a boolean value that indicates if this cluster is a parent cluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.isParent()

obj.addToCluster(cluster)

绑定状态: 已绑定

Python 调用: obj.addToCluster(cluster)

This function adds this cluster as a child cluster to the specified cluster。

异常

• oacClusterAlreadyHasParent。
• oacInvalidCluster。
• oacInvalidChildCluster。
• oacSameCluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.addToCluster(cluster)

obj.removeFromCluster()

绑定状态: 已绑定

Python 调用: obj.removeFromCluster()

This function removes this cluster from the parent cluster。 If this cluster is not a child of another cluster, this function does nothing。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.removeFromCluster()

obj.getClusters()

绑定状态: 已绑定

Python 调用: obj.getClusters()

This function returns a collection of clusters in this cluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getClusters()

obj.getInsts()

绑定状态: 已绑定

Python 调用: obj.getInsts()

This function returns a collection of instances in this cluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getInsts()

obj.getBoundaries()

绑定状态: 已绑定

Python 调用: obj.getBoundaries()

This function returns a collection containing all of the oaClusterBoundary objects associated with this cluster。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getBoundaries()

obj.getBlockagesOwnedBy()

绑定状态: 已绑定

Python 调用: obj.getBlockagesOwnedBy()

This function returns a collection containing all of the oaBlockage objects that have this cluster as owner。

Python 示例

from oapy._oa import _design

# assume obj is a oaCluster
obj.getBlockagesOwnedBy()

_design.oaCluster.create(block, name, type)

绑定状态: 已绑定

Python 调用: _design.oaCluster.create(block, name, type)

This function creates a new cluster object in the specified block with the specified attributes。

参数

• block: The block that creates the cluster。
• name: The name of the cluster。
• isExclusive: The type of cluster。

返回

• A pointer to the new oaCluster。

异常

• oacClusterNameExists。

Python 示例

from oapy._oa import _design

_design.oaCluster.create(block, name, type)

_design.oaCluster.find(block, name)

绑定状态: 已绑定

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

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

参数

• block: The block to search。
• name: The name of the cluster to find。

Python 示例

from oapy._oa import _design

_design.oaCluster.find(block, name)