oaVia
模块: oapy._oa._design
导入: from oapy._oa import _design
概览
oaVia 在 oapy 中可用,可通过 _design 模块访问。
本页汇总 oaVia 当前在 oapy 中可用的 Python 接口。
详细说明
The oaVia class is an abstract base class for vias。 A via represents a physical connection between two adjacent route pathSegs that are on different layers。 A via references a via definition ( oaViaDef ) from the technology database that corresponds to the design where the via exists。 A via may be either a standard via or a custom via。 A standard via has a pre-defined set of via parameters that can be tailored to create a variety of vias to cover a variety of connections。 The standard via references a standard via definition。 A custom via is very much like an instance where, through its custom via definition, another design is referenced。 Custom vias often include a set of parameter values that can be used to tailor the master for each specific via。 A via can represent complex pin figures although vias are normally associated with routes。 Vias always have an oaViaHeader which contains the attributes that are constant for all vias of a given via definition。 The oaVia class can be observed by deriving from oaObserver
方法总览
| 状态 | Python 调用 |
|---|---|
| ✅ | obj.getHeader() |
| ✅ | obj.getViaDef() |
| ✅ | obj.getViaDefName(name) |
| ✅ | obj.getPurposeNum() |
| ✅ | obj.getRoute() |
| ✅ | obj.getRouteStatus() |
| ✅ | obj.getRouteTopology() |
| ✅ | obj.getDirection() |
| ✅ | obj.getShieldedNet1() |
| ✅ | obj.getShieldedNet2() |
| ✅ | obj.isUnShielded() |
| ✅ | obj.hasRoute() |
| ✅ | obj.setPurposeNum(purposeNum) |
| ✅ | obj.setRouteStatus(status) |
| ✅ | obj.setRouteTopology(topology) |
| ✅ | obj.setDirection(dir) |
| ✅ | obj.setShieldedNet1(net) |
| ✅ | obj.setShieldedNet2(net) |
| ✅ | obj.setUnShielded(unShielded) |
| ✅ | obj.getConnRoutes() |
方法说明
obj.getHeader()
绑定状态: 已绑定
Python 调用: obj.getHeader()
This function returns the oaViaHeader associated with this via。 The oaViaHeader is a collection of the attributes that are common to all vias of a particular via definition。 For vias of via definitions that have parameters, this function returns the via subheader。 从 oaRef 重新实现。 在 oaStdVia 和 oaCustomVia 中重新实现。
返回
- The pointer to the via header。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getHeader()
obj.getViaDef()
绑定状态: 已绑定
Python 调用: obj.getViaDef()
This function returns the oaViaDef object associated with this via。 If the oaViaDef is not bound, a NULL is returned。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getViaDef()
obj.getViaDefName(name)
绑定状态: 已绑定
Python 调用: obj.getViaDefName(name)
This function fills out name with the name of the via definition associated with this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getViaDefName(name)
obj.getPurposeNum()
绑定状态: 已绑定
Python 调用: obj.getPurposeNum()
This function returns the purpose number associated with this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getPurposeNum()
obj.getRoute()
绑定状态: 已绑定
Python 调用: obj.getRoute()
This function returns the route to which this via may belong。 If this via does not belong to a route, a NULL is returned。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getRoute()
obj.getRouteStatus()
绑定状态: 已绑定
Python 调用: obj.getRouteStatus()
This function returns the current routing status of this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getRouteStatus()
obj.getRouteTopology()
绑定状态: 已绑定
Python 调用: obj.getRouteTopology()
This function returns the current routing topology of this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getRouteTopology()
obj.getDirection()
绑定状态: 已绑定
Python 调用: obj.getDirection()
This function returns the direction of this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getDirection()
obj.getShieldedNet1()
绑定状态: 已绑定
Python 调用: obj.getShieldedNet1()
This function returns the first net that this via is shielding。 A via may shield up to two nets。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getShieldedNet1()
obj.getShieldedNet2()
绑定状态: 已绑定
Python 调用: obj.getShieldedNet2()
This function returns the second net that this via is shielding。 A via may shield up to two nets。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getShieldedNet2()
obj.isUnShielded()
绑定状态: 已绑定
Python 调用: obj.isUnShielded()
This function returns true if this via is not shielded。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.isUnShielded()
obj.hasRoute()
绑定状态: 已绑定
Python 调用: obj.hasRoute()
This function returns true if this via is part of a route, false otherwise。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.hasRoute()
obj.setPurposeNum(purposeNum)
绑定状态: 已绑定
Python 调用: obj.setPurposeNum(purposeNum)
This function sets the purpose of this via to the specified 'purposeNum' value。
参数
purposeNum: The new technology purpose number to associate with this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setPurposeNum(purposeNum)
obj.setRouteStatus(status)
绑定状态: 已绑定
Python 调用: obj.setRouteStatus(status)
This function sets the routeStatus of this via to the specified 'status'。
参数
status: The routing status to be set for this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setRouteStatus(status)
obj.setRouteTopology(topology)
绑定状态: 已绑定
Python 调用: obj.setRouteTopology(topology)
This function sets the routeTopology of this via to the specified 'topology'。
参数
topology: The routing topology to be set for this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setRouteTopology(topology)
obj.setDirection(dir)
绑定状态: 已绑定
Python 调用: obj.setDirection(dir)
This function sets the direction of this via to the specified 'dir'。
参数
dir: The direction to be set for this via。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setDirection(dir)
obj.setShieldedNet1(net)
绑定状态: 已绑定
Python 调用: obj.setShieldedNet1(net)
This function sets the first shielded net for this via to the specified bit net。 A via may shield up to two nets。 A NULL pointer resets the attribute。 Exceptions are thrown if the bit net is not in the same database as this via。
参数
net: Bit net that is shielded by this via。
异常
oacNetFigNotInSameBlock。oacObjectAlreadyShieldsNet。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setShieldedNet1(net)
obj.setShieldedNet2(net)
绑定状态: 已绑定
Python 调用: obj.setShieldedNet2(net)
This function sets the second shielded net for this via to the specified bit net。 A via may shield up to two nets。 A NULL pointer resets the attribute。 Exceptions are thrown if the bit net is not in the same database as this via。
参数
net: Bit net that is shielded by this via。
异常
oacNetFigNotInSameBlock。oacObjectAlreadyShieldsNet。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setShieldedNet2(net)
obj.setUnShielded(unShielded)
绑定状态: 已绑定
Python 调用: obj.setUnShielded(unShielded)
This function sets the unShielded attribute of this via to the specified value。
参数
unShielded: value。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.setUnShielded(unShielded)
obj.getConnRoutes()
绑定状态: 已绑定
Python 调用: obj.getConnRoutes()
This function returns a collection of routes that are connected to this via。 Each route in the collection has this via as either its startConn, endConn, or both。
Python 示例
from oapy._oa import _design
# assume obj is a oaVia
obj.getConnRoutes()