oaInductor Class Reference

Inheritance diagram for oaInductor:

Public Methods
oaCollection< oaMutualInductor, oaInductor >	getFromMutualInductors () const
oaCollection< oaMutualInductor, oaInductor >	getToMutualInductors () const
Static Public Methods
oaInductor *	create (oaNode *fromNode, oaNode *toNode)
oaInductor *	create (oaNode *fromNode, oaNode *toNode, oaUInt4 id)

---

Detailed Description

The oaInductor class represents an inductor in a parasitic network for a net. Each inductor object has one inductance value for each analysis point that the parasitic network represents.

---

Member Function Documentation

oaInductor * oaInductor::create (  oaNode *    fromNode, oaNode *    toNode, oaUInt4    id )  [static]

This function creates an inductor belonging to the parasitic network containing fromNode and toNode. An exception will be thrown if fromNode and toNode do not belong to the same network. 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. Inductors 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 inductor 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. Parameters: fromNode  The starting node for the inductor toNode  The ending node for the inductor id  The unique ID to be assigned to the inductor created Exceptions: oacInvalidDeviceIdSpecified  oacLocalDeviceIdExists  oacNodesNotInSameDesign  oacNodesNotInSameNetwork  oacNodesNotInRelatedPartitions  oacAncestorNodeWithoutId

oaInductor * oaInductor::create (  oaNode *    fromNode, oaNode *    toNode )  [static]

This function creates an inductor belonging to the parasitic network containing fromNode and toNode. An exception will be thrown if fromNode and toNode are specified and do not belong to the same 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. Inductors 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 inductor 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. Parameters: fromNode  The starting node for the inductor toNode  The ending node for the inductor Exceptions: oacNodesNotInSameDesign  oacNodesNotInSameNetwork  oacNodesNotInRelatedPartitions  oacAncestorNodeWithoutId

oaCollection oaInductor::getFromMutualInductors (    )  const

This function returns a collection of mutual inductors whose from endpoint connects to this inductor.

oaCollection oaInductor::getToMutualInductors (    )  const

This function returns a collection of mutual inductors whose to endpoint connects to this inductor.

---

The documentation for this class was generated from the following files:

• oaInductor.h
• oaInductor.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.