oaMutualInductor Class Reference

Inheritance diagram for oaMutualInductor:

Public Methods
oaBoolean	isLocal () const
void	setValue (const oaAnalysisPoint *ap, oaFloat value)
oaFloat	getValue (const oaAnalysisPoint *ap) const
oaInductor *	getInductor (oaEndpointType endpoint) const
oaInductor *	getOtherInductor (oaInductor *inductor) const
void	getOtherInductor (oaDesignObject *&otherNet, oaUInt4 &otherInductorId) const
Static Public Methods
oaMutualInductor *	create (oaInductor *fromInductor, oaInductor *toInductor)
oaMutualInductor *	create (oaInductor *fromInductor, oaInductor *toInductor, oaUInt4 id)
oaMutualInductor *	create (oaInductor *fromInductor, oaDesignObject *otherNet, oaUInt4 otherInductorId, oaUInt4 id)

---

Detailed Description

The oaMutualInductor class represents the mutual inductance between two inductor devices. The two inductors can be within the same parasitic network or within the parasitic networks for two different nets.

---

Member Function Documentation

oaMutualInductor * oaMutualInductor::create (  oaInductor *    fromInductor, oaDesignObject *    otherNet, oaUInt4    otherInductorId, oaUInt4    id )  [static]

This function creates a mutual inductor in fromInductor's parasitic network that couples between fromInductor and an inductor in the parasitic network for another net. The parasitic network for otherNet does not have to exist or be in memory at the time this function is called. The otherInductorId value specifies a unique ID for the inductor in otherNet's parasitic network, and that ID must be specified when the inductor is created. If the inductance is between 2 nets, those nets must be in a single hierarchy domain. Each must be an oaNet, or each must be an oaOccNet. Parameters: fromInductor  The inductor from which to couple otherNet  The other network to which to couple otherInductorId  A unique ID for the inductor in the other parasitic network id  The unique ID value Exceptions: oacCoupledInductorWithoutId  oacInvalidNet  oacInvalidMutualInductorId  oacInductorNetNotInSameDesign  oacDeviceNetNotInSameDomain  oacNonLocalDeviceIdExists

oaMutualInductor * oaMutualInductor::create (  oaInductor *    fromInductor, oaInductor *    toInductor, oaUInt4    id )  [static]

This function creates a local mutual inductor between the specified pair of inductors. An exception will be thrown if the two inductors are not in the same design. An explicit unique mutual inductor ID id is required to be specified. An exception will be thrown if the id is the reserved oacInvalidDeviceID value or if a mutual inductor with the specified id value already exists. The hasId() function will return true for mutual inductors created with this function and the getId() function will return the user-specified id. Mutual inductors can be created between inductors 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 mutual inductor device will be created in the lower level partition, and the inductor in the higher level partition must have an id so that it can be found when loading the lower level partition. Parameters: fromInductor  The inductor from which to couple toInductor  The inductor to which to couple id  The unique ID value Exceptions: oacInvalidDeviceIdSpecified  oacLocalDeviceIdExists  oacInductorsNotInSameDesign  oacInductorsNotInSameNetwork  oacInductorsNotInRelatedPartitions  oacAncestorInductorWithoutId

oaMutualInductor * oaMutualInductor::create (  oaInductor *    fromInductor, oaInductor *    toInductor )  [static]

This function creates a local mutual inductor between the specified pair of inductors. An exception will be thrown if the two inductors are not in the same design. The mutual inductor created does not have an ID associated with it. The hasId() function will return false for these inductors and the getId() function will return an oacInvalidDeviceID value. Mutual inductors can be created between inductors 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 mutual inductor device will be created in the lower level partition, and the inductor in the higher level partition must have an id so that it can be found when loading the lower level partition. Parameters: fromInductor  The inductor from which to couple toInductor  The inductor to which to couple Exceptions: oacInductorsNotInSameDesign  oacInductorsNotInSameNetwork  oacInductorsNotInRelatedPartitions  oacAncestorInductorWithoutId

oaInductor * oaMutualInductor::getInductor (  oaEndpointType    endpoint )  const

This function returns the inductor connected to the specified endpoint of this mutual inductor. If this mutual inductor couples to an inductor within another parasitic network, NULL is returned for the "to" endpoint. Parameters: endpoint  The endpoint value

void oaMutualInductor::getOtherInductor (  oaDesignObject *&    otherNet, oaUInt4 &    otherInductorId )  const

This function returns information about the inductor connected to the "to" endpoint of this device. The parasitic network for otherNet does not have to exist or be in memory at the time that this function is called. When this is a local mutual inductor, the otherInductorId is set to oacNullIndex if the other inductor does not have an ID. Parameters: otherNet  The other network from which to return information otherInductorId  A unique ID for the inductor in the other parasitic network

oaInductor * oaMutualInductor::getOtherInductor (  oaInductor *    inductor )  const

This function returns the inductor connected to the other endpoint of this device (the endpoint that is not connected to inductor). When inductor is the from endpoint of this mutual inductor and this mutual inductor couples to an inductor within another parasitic network, NULL is returned. Parameters: inductor  The inductor connected to the other endpoint of this device

oaFloat oaMutualInductor::getValue (  const oaAnalysisPoint *    ap )  const

This function returns the mutual inductance value of this device for the specified analysis point. Parameters: ap  The analysis point for which to return the mutual inductance

oaBoolean oaMutualInductor::isLocal (    )  const

This function returns true if this mutual inductor connects two inductors within the same parasitic network.

void oaMutualInductor::setValue (  const oaAnalysisPoint *    ap, oaFloat    value )

This function sets the mutual inductance value of this device for the specified analysis point. Parameters: ap  The analysis point for which to set the mutual inductance value  The inductance value to set

---

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

• oaMutualInductor.h
• oaMutualInductor.dox

Return to top of page

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