oaResistor Class Reference

Inheritance diagram for oaResistor:

Public Methods
oaUInt4	getWidth () const
oaUInt4	getLength () const
oaUInt4	getHeight () const
oaUInt4	getNumCuts () const
oaUInt4	getCutArea () const
oaUInt4	getCutPerimeter () const
oaBoolean	hasWidth () const
oaBoolean	hasLength () const
oaBoolean	hasHeight () const
oaBoolean	hasNumCuts () const
oaBoolean	hasCutArea () const
oaBoolean	hasCutPerimeter () const
void	setWidth (oaUInt4 width)
void	setLength (oaUInt4 length)
void	setHeight (oaUInt4 height)
void	setNumCuts (oaUInt4 numCuts)
void	setCutArea (oaUInt4 cutArea)
void	setCutPerimeter (oaUInt4 cutPerimeter)
Static Public Methods
oaResistor *	create (oaNode *fromNode, oaNode *toNode)
oaResistor *	create (oaNode *fromNode, oaNode *toNode, oaUInt4 id)

---

Detailed Description

The oaResistor class represents a resistor in a parasitic network for a net. Each resistor object has one resistance value for each analysis point that the parasitic network represents.

---

Member Function Documentation

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

This function creates a resistor belonging to the parasitic network containing fromNode and toNode. 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. Resistors 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 resistor 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 resistor toNode  The ending node for the resistor id  The unique ID to be assigned to the resistor created Exceptions: oacInvalidDeviceIdSpecified  oacLocalDeviceIdExists  oacNodesNotInSameDesign  oacNodesNotInSameNetwork  oacNodesNotInRelatedPartitions  oacAncestorNodeWithoutId

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

This function creates a resistor 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. Resistors 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 resistor 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

oaUInt4 oaResistor::getCutArea (    )  const

This function returns the cut area associated with this resistor.

oaUInt4 oaResistor::getCutPerimeter (    )  const

This function returns the cut area perimeter associated with this resistor.

oaUInt4 oaResistor::getHeight (    )  const

This function returns the effective height associated with this resistor.

oaUInt4 oaResistor::getLength (    )  const

This function returns the effective length associated with this resistor.

oaUInt4 oaResistor::getNumCuts (    )  const

This function returns the number of cuts associated with this resistor.

oaUInt4 oaResistor::getWidth (    )  const

This function returns the effective width associated with this resistor.

oaBoolean oaResistor::hasCutArea (    )  const

This function returns a boolean indicating whether or not this resistor has cut area.

oaBoolean oaResistor::hasCutPerimeter (    )  const

This function returns a boolean indicating whether or not this resistor has cut perimeter.

oaBoolean oaResistor::hasHeight (    )  const

This function returns a boolean indicating whether or not this resistor has height.

oaBoolean oaResistor::hasLength (    )  const

This function returns a boolean indicating whether or not this resistor has length.

oaBoolean oaResistor::hasNumCuts (    )  const

This function returns a boolean indicating whether or not this resistor has number of cuts.

oaBoolean oaResistor::hasWidth (    )  const

This function returns a boolean indicating whether or not this resistor has width.

void oaResistor::setCutArea (  oaUInt4    cutArea )

This function sets the cut area of this resistor to the specified value. Parameters: cutArea  the cut area to set on this oaResistor object

void oaResistor::setCutPerimeter (  oaUInt4    cutPerimeter )

This function sets the cut perimeter of this resistor to the specified value. Parameters: cutPerimeter  the cut perimeter to set on this oaResistor object

void oaResistor::setHeight (  oaUInt4    height )

This function sets the effective height of this resistor to the specified height. Parameters: height  the effective height to set on this oaResistor object

void oaResistor::setLength (  oaUInt4    length )

This function sets the effective length of this resistor to the specified length. Parameters: length  the effective length to set on this oaResistor object

void oaResistor::setNumCuts (  oaUInt4    numCuts )

This function sets the number of cuts of this resistor to the specified value. Parameters: numCuts  the number of cuts to set on this oaResistor object

void oaResistor::setWidth (  oaUInt4    width )

This function sets the effective width of this resistor to the specified width. Parameters: width  the effective width to set on this oaResistor object

---

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

• oaResistor.h
• oaResistor.dox

Return to top of page

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