oaPiPoleResidue Class Reference

Inheritance diagram for oaPiPoleResidue:

oaReducedModel oaDesignObject oaObject


Public Methods

void setNearCap (oaFloat value)
void setRes (oaFloat value)
void setFarCap (oaFloat value)
void setPiModel (oaFloat nearCap, oaFloat res, oaFloat farCap)
oaFloat getNearCap () const
oaFloat getRes () const
oaFloat getFarCap () const
void getPiModel (oaFloat &nearCap, oaFloat &res, oaFloat &farCap) const
oaCollection< oaPoleResidue, oaPiPoleResidue > getPoleResidues () const

Static Public Methods

oaPiPoleResidue * create (oaDesignObject *driver, const oaAnalysisPoint *ap, oaFloat nearCap, oaFloat res, oaFloat farCap)
oaPiPoleResidue * find (const oaDesignObject *driver, const oaAnalysisPoint *ap)

Detailed Description

The oaPiPoleResidue class represents a reduced model for the parasitics seen by a driver of a net using a PI model. The PI model consists of two capacitors and a resistor between them, with nearCap being the capacitor closer to the driver. For each receiver, an oaPoleResidue object represents a set of poles and residues that approximate the transfer function for the interconnect parasitics from the driver to that receiver.

Undo is not supported for oaPiPoleResidue objects.

Member Function Documentation

oaPiPoleResidue * oaPiPoleResidue::create (  oaDesignObject *    driver,
const oaAnalysisPoint *    ap,
oaFloat    nearCap,
oaFloat    res,
oaFloat    farCap
)  [static]
 

This function creates a piPoleResidue model for the specified driver object and analysis point. The driver can be terminal or instTerm in block or occurrence domain.

Exceptions:
oacInvalidReducedModelDomain 
oacInvalidReducedModelObjectType 
oacInvalidDriverTermType 
oacParasiticTermMustBeScalar 
oacParasiticInstTermMustBeScalar 

oaPiPoleResidue * oaPiPoleResidue::find (  const oaDesignObject *    driver,
const oaAnalysisPoint *    ap
)  [static]
 

This function finds the piPoleResidue on the specified driver and analysisPoint. If found it returns the object, otherwise it returns null pointer to the caller.

oaFloat oaPiPoleResidue::getFarCap (    )  const
 

This function returns the value of the capacitor farthest from the driver in the PI model.

oaFloat oaPiPoleResidue::getNearCap (    )  const
 

This function returns the value of the capacitor closest to the driver in the PI model.

oaFloat oaPiPoleResidue::getPiModel (  oaFloat &    nearCap,
oaFloat &    res,
oaFloat &    farCap
)  const
 

This function returns the PI model values of this oaPiPoleResidue.

oaCollection oaPiPoleResidue::getPoleResidues (    )  const
 

This function returns a collection of poleResidues for the receivers in this reduced model.

oaFloat oaPiPoleResidue::getRes (    )  const
 

This function returns the value of the resistor in the PI model.

void oaPiPoleResidue::setFarCap (  oaFloat    value ) 
 

This function sets the value of the capacitor farthest from the driver in the PI model.

void oaPiPoleResidue::setNearCap (  oaFloat    value ) 
 

This function sets the value of the capacitor closest to the driver in the PI model.

void oaPiPoleResidue::setPiModel (  oaFloat    nearCap,
oaFloat    res,
oaFloat    farCap
) 
 

This function sets the PI model values for this oaPiPoleResidue.

void oaPiPoleResidue::setRes (  oaFloat    value ) 
 

This function sets the value of the resistor in the PI model.

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

Return to top of page




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