oaNode

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

概览

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

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

详细说明

The oaNode class represents nodes contained within an oaParasiticNetwork 。 Nodes connect devices, terms and instTerms。 They can also describe the physical location of a point within the routing topology, which is useful when a long wire is broken into a series of distributed parasitic elements。 In that case, the layer and origin represent the position of the node along the wire。 Capacitance between a node and an implicit ground can be represented using the oaGroundedNode derived class。 Nodes are managed objects, but they can be loaded from disk into memory (and unloaded from memory back to disk) on request as part of the parasitic network to which they belong。 A pointer to a node becomes invalid after the parasitic network to which it belongs has been unloaded。 Nodes can have an integer ID that is chosen by the client that creates them。 The ID is usually optional, but IDs are required for nodes that are to be connected to a coupling capacitor between two different networks。 IDs are also required for nodes that are the endpoint of a device in a lower-level parasitic network partition。 When specified, IDs must be unique across all of the nodes within the same parasitic network。 The getUniqueId() function can be used to obtain consecutive unique IDs。 Nodes can also have an optional name string chosen by the client that creates them。 This is primarily useful for small custom designs, as assigning a separate name to every node in large digital designs is prohibitively expensive。 Node names must be unique within the same parasitic network。 Undo, properties, and groups are not supported for oaNode。 Extensions on oaNode (and interPointer extensions that refer to an oaNode) are only accessible while the oaNode is loaded。 The oaNode class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.destroy()
✅	obj.setName(name)
✅	obj.setLayerNum(layer)
✅	obj.setLocation(location)
✅	obj.hasId()
✅	obj.hasLayerNum()
✅	obj.hasLocation()
✅	obj.getParasiticNetwork()
✅	obj.getId()
✅	obj.getName(name)
✅	obj.getLayerNum()
✅	obj.getLocation(location)
✅	obj.addConn(conn)
✅	obj.removeConn(conn)
✅	obj.addToSubNetwork(subNetwork)
✅	obj.removeFromSubNetwork(subNetwork)
✅	obj.getFromDevices()
✅	obj.getToDevices()
✅	obj.getSubNetworks()
✅	obj.getConns()
✅	_design.oaNode.create(network)
✅	_design.oaNode.create(network, id)
✅	_design.oaNode.find(network, id)
✅	_design.oaNode.find(network, name)
✅	_design.oaNode.isValidName(network, name)
✅	_design.oaNode.getUniqueId(network)

方法说明

obj.destroy()

绑定状态: 已绑定

Python 调用: obj.destroy()

This function destroys this node, removing it from the database。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.destroy()

obj.setName(name)

绑定状态: 已绑定

Python 调用: obj.setName(name)

This function sets the name of this node。

参数

• name: A reference to an oaString object that holds the new name for this node。

异常

• oacNodeNameExists。

Python 示例

from oapy._oa import _design

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

obj.setLayerNum(layer)

绑定状态: 已绑定

Python 调用: obj.setLayerNum(layer)

This function sets the layer number of this node。

参数

• layer: The layer number to be associated with this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.setLayerNum(layer)

obj.setLocation(location)

绑定状态: 已绑定

Python 调用: obj.setLocation(location)

This function sets the location of this node。

参数

• location: A reference to an oaPoint object that holds the new location for this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.setLocation(location)

obj.hasId()

绑定状态: 已绑定

Python 调用: obj.hasId()

This function returns a boolean indicating whether or not this node has a user-specified ID associated with it。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.hasId()

obj.hasLayerNum()

绑定状态: 已绑定

Python 调用: obj.hasLayerNum()

This function returns a boolean value that indicates if a layer number has been set for this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.hasLayerNum()

obj.hasLocation()

绑定状态: 已绑定

Python 调用: obj.hasLocation()

This function returns a boolean value that indicates if a location has been set for this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.hasLocation()

obj.getParasiticNetwork()

绑定状态: 已绑定

Python 调用: obj.getParasiticNetwork()

This function returns the parasiticNetwork to which this node belongs。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getParasiticNetwork()

obj.getId()

绑定状态: 已绑定

Python 调用: obj.getId()

This function returns the optional ID if one was assigned to the node when it was created。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getId()

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function returns the name of this node。 If no name has been set, the returned string is empty。

参数

• name: A reference to an oaString object to be populated with the node's name。

Python 示例

from oapy._oa import _design

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

obj.getLayerNum()

绑定状态: 已绑定

Python 调用: obj.getLayerNum()

This function returns the layer number for this node。 If the layer number has never been set (the hasLayerNum() function returns false), the value returned by this function is undefined。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getLayerNum()

obj.getLocation(location)

绑定状态: 已绑定

Python 调用: obj.getLocation(location)

This function returns the location of this node。 If no location has been set, the returned point is at (0, 0)。

参数

• location: A reference to an oaPoint object to be populated with the node's location。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getLocation(location)

obj.addConn(conn)

绑定状态: 已绑定

Python 调用: obj.addConn(conn)

This function adds a connection to this node。 The conn object must be a bitTerm or an instTerm。 For a ParasiticNetwork that is on an oaNet the object must be an oaBitTerm or oaInstTerm 。 For a parasiticNetwork on an occNet, the object must be an oaOccBitTerm or oaOccInstTerm 。 When a terminal is represented by more than one node, it is particularly important for the node to have a layer and location。 This enables applications that stitch parasitics across hierarchical boundaries to properly match the node for the terminal with the node for the instTerm。 Note: This function throws an oacInvalidNodeConnNet exception if the node and the conn are not on the same or equivalent nets in the block domain。 A similar check is not performed in the occurrence domain。

参数

• conn: The connection to be added to this node。

异常

• oacInvalidNodeConnType。
• oacInvalidNodeConnNet。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.addConn(conn)

obj.removeConn(conn)

绑定状态: 已绑定

Python 调用: obj.removeConn(conn)

This function removes a connection from this node。 The conn object must be a terminal or instTerm ( oaTerm , oaInstTerm , oaOccTerm or oaOccInstTerm ) that was previously connected to the node。

参数

• conn: The connection to be removed from the node。

异常

• oacInvalidNodeConnType。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.removeConn(conn)

obj.addToSubNetwork(subNetwork)

绑定状态: 已绑定

Python 调用: obj.addToSubNetwork(subNetwork)

This function adds this node to the specified subNetwork。

参数

• subNetwork: The sub-network to which the node will be added。

异常

• oacSubNetworkNodeNotSameDesign。
• oacSubNetworkNodeNotSameNetwork。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.addToSubNetwork(subNetwork)

obj.removeFromSubNetwork(subNetwork)

绑定状态: 已绑定

Python 调用: obj.removeFromSubNetwork(subNetwork)

This function removes this node from the specified subNetwork。

参数

• subNetwork: The sub-network from which this node is to be removed。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.removeFromSubNetwork(subNetwork)

obj.getFromDevices()

绑定状态: 已绑定

Python 调用: obj.getFromDevices()

This function returns a collection containing the devices whose from endpoint is connected to this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getFromDevices()

obj.getToDevices()

绑定状态: 已绑定

Python 调用: obj.getToDevices()

This function returns a collection containing the devices whose to endpoint is connected to this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getToDevices()

obj.getSubNetworks()

绑定状态: 已绑定

Python 调用: obj.getSubNetworks()

This function returns a collection of the subNetworks to which this node belongs。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getSubNetworks()

obj.getConns()

绑定状态: 已绑定

Python 调用: obj.getConns()

This function returns a collection containing the connections to this node。

Python 示例

from oapy._oa import _design

# assume obj is a oaNode
obj.getConns()

_design.oaNode.create(network)

绑定状态: 已绑定

Python 调用: _design.oaNode.create(network)

This function creates a node belonging to the specified parasitic network。 An explicit unique node ID 'id' is required to be specified。 An exception will be thrown if the 'id' is the reserved oacInvalidNodeID value or if a node with the specified 'id' value already exists。 The hasId() function will return true for nodes created with these functions and the getId() function will return the user-specified node id。 在 oaGroundedNode 中重新实现。

参数

• network: The parasitic network to which the created node will belong。
• id: A unique ID to be associated with the node。

异常

• oacNodeIdExists。
• oacInvalidNodeIdSpecified。

Python 示例

from oapy._oa import _design

_design.oaNode.create(network)

_design.oaNode.create(network, id)

绑定状态: 已绑定

Python 调用: _design.oaNode.create(network, id)

This function creates a node belonging to the specified parasitic network。 The node created does not have an ID associated with it。 The hasId() function will return false for these nodes and the getId() function will return an oacInvalidNodeID value。 在 oaGroundedNode 中重新实现。

参数

• network: The parasitic network to which the created node will belong。

Python 示例

from oapy._oa import _design

_design.oaNode.create(network, id)

_design.oaNode.find(network, id)

绑定状态: 已绑定

Python 调用: _design.oaNode.find(network, id)

This function finds and returns the node with the specified name within network。

参数

• network: The parasitic network to search for the node。
• name: The name of the node to look for。

Python 示例

from oapy._oa import _design

_design.oaNode.find(network, id)

_design.oaNode.find(network, name)

绑定状态: 已绑定

Python 调用: _design.oaNode.find(network, name)

This function finds and returns the node with the specified id within network。

参数

• network: The parasitic network to search for the node。
• id: The unique ID of the node to look for。

Python 示例

from oapy._oa import _design

_design.oaNode.find(network, name)

_design.oaNode.isValidName(network, name)

绑定状态: 已绑定

Python 调用: _design.oaNode.isValidName(network, name)

This function returns a boolean value that indicates if the specified name is valid for a new oaNode object within the specified parasitic network。

参数

• network: The parasitic network in whose domain the name is to be validated。
• name: A reference to an oaString object holding the name to be validated。

Python 示例

from oapy._oa import _design

_design.oaNode.isValidName(network, name)

_design.oaNode.getUniqueId(network)

绑定状态: 已绑定

Python 调用: _design.oaNode.getUniqueId(network)

This function returns a unique ID for a node in network。

参数

• network: The parasitic network to determine the potential unique ID for this node。

Python 示例

from oapy._oa import _design

_design.oaNode.getUniqueId(network)