oaSeriesRL

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

概览

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

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

详细说明

The oaSeriesRL class represents a resistor and inductor connected in series, where the node between the two devices is not of interest。 Each oaSeriesRL object has both a resistance value and an inductance value for each analysis point that the parasitic network represents。

方法总览

状态	Python 调用
✅	`obj.getNode(endpoint)`
✅	`obj.getOtherNode(node)`
✅	`obj.getEndpoint(node)`
✅	`obj.setValue(ap, resistance, inductance)`
✅	`obj.getValue(ap, resistance, inductance)`
✅	`_design.oaSeriesRL.create(fromNode, toNode)`
✅	`_design.oaSeriesRL.create(fromNode, toNode, id)`

方法说明

`obj.getNode(endpoint)`

绑定状态: 已绑定

Python 调用: obj.getNode(endpoint)

This function returns the node connected to the specified endpoint of this device。

参数

endpoint: The endPointType of the device for which the corresponding node is to be obtained。

Python 示例

from oapy._oa import _design

# assume obj is a oaSeriesRL
obj.getNode(endpoint)

`obj.getOtherNode(node)`

绑定状态: 已绑定

Python 调用: obj.getOtherNode(node)

This function returns the node connected to the other endpoint of this device (the endpoint that is not connected to node)。

参数

node: The node connected at the other end of the device。

Python 示例

from oapy._oa import _design

# assume obj is a oaSeriesRL
obj.getOtherNode(node)

`obj.getEndpoint(node)`

绑定状态: 已绑定

Python 调用: obj.getEndpoint(node)

This function returns the endpoint of this device to which node is connected。

参数

node: The node whose endPointType is to be queried。

异常

oacDeviceNotConnectedToNode。

Python 示例

from oapy._oa import _design

# assume obj is a oaSeriesRL
obj.getEndpoint(node)

`obj.setValue(ap, resistance, inductance)`

绑定状态: 已绑定

Python 调用: obj.setValue(ap, resistance, inductance)

This function sets the resistance and inductance values of this device for a particular analysis point。 OpenAccess assumes resistance is specified in Ohms and inductance in Henrys。

参数

ap: The analysis point for this device for which the resistance and inductance are to be set。
resistance: An oaFloat holding the resistance value in Ohms。
inductance: An oaFloat holding the inductance value in Henrys。

Python 示例

from oapy._oa import _design

# assume obj is a oaSeriesRL
obj.setValue(ap, resistance, inductance)

`obj.getValue(ap, resistance, inductance)`

绑定状态: 已绑定

Python 调用: obj.getValue(ap, resistance, inductance)

This function gets the resistance and inductance values of this device for a particular analysis point。 OpenAccess assumes resistance is specified in Ohms and inductance in Henrys。

参数

ap: The analysis point for this device for which the resistance and inductance are to be queried。
resistance: A reference to an oaFloat to be populated with the resistance value in Ohms。
inductance: A reference to an oaFloat to be populated with the inductance value in Henrys。

Python 示例

from oapy._oa import _design

# assume obj is a oaSeriesRL
obj.getValue(ap, resistance, inductance)

`_design.oaSeriesRL.create(fromNode, toNode)`

绑定状态: 已绑定

Python 调用: _design.oaSeriesRL.create(fromNode, toNode)

This function creates a seriesRL device belonging to the parasitic network containing fromNode and toNode。 An explicit unique ID id is required to be specified。 An exception will be thrown if the id is the reserved oacInvalidDeviceID value or if a device with the specified id value already exists。 The hasId() function will return true for devices created with this function and the getId() function will return the user-specified id。 SeriesRL devices can be created between nodes in different partitions of the same root parasitic network, where one of the partitions must be an ancestor of the other。 In this case, the seriesRL device will be created in the lower level partition, and the node in the higher level partition must have an id so that it can be found when loading the lower level partition。

参数

fromNode: The start node for the seriesRL device。
toNode: The end node for the seriesRL device。
id: The unique ID to be assigned to this device。

异常

oacInvalidDeviceIdSpecified。
oacLocalDeviceIdExists。
oacNodesNotInSameDesign。
oacNodesNotInSameNetwork。
oacNodesNotInRelatedPartitions。
oacAncestorNodeWithoutId。

Python 示例

from oapy._oa import _design

_design.oaSeriesRL.create(fromNode, toNode)

`_design.oaSeriesRL.create(fromNode, toNode, id)`

绑定状态: 已绑定

Python 调用: _design.oaSeriesRL.create(fromNode, toNode, id)

This function creates a seriesRL device belonging to the specified parasitic network。 The device created will not have an ID associated with it。 The hasId() function will return false for these devices, and the getId() function will return an oacInvalidDeviceID value。 SeriesRL devices can be created between nodes in different partitions of the same root parasitic network, where one of the partitions must be an ancestor of the other。 In this case, the seriesRL device will be created in the lower level partition, and the node in the higher level partition must have an id so that it can be found when loading the lower level partition。

参数

fromNode: The start node for the seriesRL device。
toNode: The end node for the seriesRL device。

异常

oacNodesNotInSameDesign。
oacNodesNotInSameNetwork。
oacNodesNotInRelatedPartitions。
oacAncestorNodeWithoutId。

Python 示例

from oapy._oa import _design

_design.oaSeriesRL.create(fromNode, toNode, id)