oaGuide

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

概览

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

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

详细说明

The oaGuide class specifies a connection between two objects that are intended to be wired together。 Guides are generally replaced with physical objects when the wiring for the net is completed。 Guides can be used before the detailed location of the wiring is known, but after the branching of the wire into segments for each end point is known and/or layer constraints are known。 Guides also qualify as route objects and can be added to routes。 The oaGuide class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.getBeginLayerHeader()
✅	obj.getEndLayerHeader()
✅	obj.getPoints(beginPoint, endPoint)
✅	obj.getBeginLayerNum()
✅	obj.getEndLayerNum()
✅	obj.getRoute()
✅	obj.hasRoute()
✅	obj.followLayers()
✅	obj.setPoints(beginPoint, endPoint)
✅	obj.setBeginLayerNum(layer)
✅	obj.setEndLayerNum(layer)
✅	obj.setFollowLayers(value)
✅	_design.oaGuide.create(block, beginPoint, endPoint, beginLayer=oacAnyLayerNum, endLayer=oacAnyLayerNum)

方法说明

obj.getBeginLayerHeader()

绑定状态: 已绑定

Python 调用: obj.getBeginLayerHeader()

This function returns the layerHeader for the begin layer of this guide。 If there is no specific begin layer associated with this guide, a NULL is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getBeginLayerHeader()

obj.getEndLayerHeader()

绑定状态: 已绑定

Python 调用: obj.getEndLayerHeader()

This function returns the layerHeader for the end layer of this guide。 If there is no specific end layer associated with this guide, a NULL is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getEndLayerHeader()

obj.getPoints(beginPoint, endPoint)

绑定状态: 已绑定

Python 调用: obj.getPoints(beginPoint, endPoint)

This function returns the begin and end points for this guide in the given oaPoint parameters。

参数

• beginPoint: The begin point is returned in this parameter。
• endPoint: The end point is returned in this parameter。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getPoints(beginPoint, endPoint)

obj.getBeginLayerNum()

绑定状态: 已绑定

Python 调用: obj.getBeginLayerNum()

This function returns the layer number where this guide begins。 If one hasn't been specified then an oacAnyLayerNum value is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getBeginLayerNum()

obj.getEndLayerNum()

绑定状态: 已绑定

Python 调用: obj.getEndLayerNum()

This function returns the end layer number of this guide。 If one hasn't been specified then an oacAnyLayerNumValue is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getEndLayerNum()

obj.getRoute()

绑定状态: 已绑定

Python 调用: obj.getRoute()

This function returns the route this guide is attached to。 If this guide is not attached to a route, NULL is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.getRoute()

obj.hasRoute()

绑定状态: 已绑定

Python 调用: obj.hasRoute()

This function returns a boolean indicating whether this guide belongs to a route。 true is returned if the guide belongs to a route; false otherwise。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.hasRoute()

obj.followLayers()

绑定状态: 已绑定

Python 调用: obj.followLayers()

This function returns a boolean indicating whether the layers specified must be followed when attempting to replace this guide with physical routing。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.followLayers()

obj.setPoints(beginPoint, endPoint)

绑定状态: 已绑定

Python 调用: obj.setPoints(beginPoint, endPoint)

This function changes the begin and end points for this guide。

参数

• beginPoint: The new begin point for this guide。
• endPoint: The new end point for this guide。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.setPoints(beginPoint, endPoint)

obj.setBeginLayerNum(layer)

绑定状态: 已绑定

Python 调用: obj.setBeginLayerNum(layer)

This function changes the begin layer for this guide。

参数

• layer: The layer number of the new begin layer for this guide。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.setBeginLayerNum(layer)

obj.setEndLayerNum(layer)

绑定状态: 已绑定

Python 调用: obj.setEndLayerNum(layer)

This function changes the end layer for this guide。

参数

• layer: The layer number of the new end layer for this guide。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.setEndLayerNum(layer)

obj.setFollowLayers(value)

绑定状态: 已绑定

Python 调用: obj.setFollowLayers(value)

This function changes the follow layers attribute for this guide to the specified value。

Python 示例

from oapy._oa import _design

# assume obj is a oaGuide
obj.setFollowLayers(value)

_design.oaGuide.create(block, beginPoint, endPoint, beginLayer=oacAnyLayerNum, endLayer=oacAnyLayerNum)

绑定状态: 已绑定

Python 调用: _design.oaGuide.create(block, beginPoint, endPoint, beginLayer=oacAnyLayerNum, endLayer=oacAnyLayerNum)

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

参数

• block: The block in which to create this guide。
• beginPoint: The begin point for this guide。
• endPoint: The end point for this guide。 The end point may be the same as the begin point。
• beginLayer: An optional begin layer number for this guide。
• endLayer: An optional end layer number for this guide。

Python 示例

from oapy._oa import _design

_design.oaGuide.create(block, beginPoint, endPoint, beginLayer=oacAnyLayerNum, endLayer=oacAnyLayerNum)