oaSeriesRL Class Reference

Inheritance diagram for oaSeriesRL:

Public Methods
oaNode *	getNode (oaEndpointType endpoint) const
oaNode *	getOtherNode (oaNode *node) const
oaEndpointType	getEndpoint (oaNode *node) const
void	setValue (const oaAnalysisPoint *ap, oaFloat resistance, oaFloat inductance)
void	getValue (const oaAnalysisPoint *ap, oaFloat &resistance, oaFloat &inductance) const
Static Public Methods
oaSeriesRL *	create (oaNode *fromNode, oaNode *toNode)
oaSeriesRL *	create (oaNode *fromNode, oaNode *toNode, oaUInt4 id)

---

Detailed Description

The oaSeriesRL class represents a resistor and inductor connected in series, where the node between the two devices is not of interest. Each oaSeriesRL object has both a resistance value and an inductance value for each analysis point that the parasitic network represents.

---

Member Function Documentation

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

This function creates a seriesRL device belonging to the parasitic network containing fromNode and toNode. An explicit unique ID id is required to be specified. 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. SeriesRL devices 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 seriesRL device 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 start node for the seriesRL device toNode  The end node for the seriesRL device id  The unique ID to be assigned to this device Exceptions: oacInvalidDeviceIdSpecified  oacLocalDeviceIdExists  oacNodesNotInSameDesign  oacNodesNotInSameNetwork  oacNodesNotInRelatedPartitions  oacAncestorNodeWithoutId

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

This function creates a seriesRL device 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. SeriesRL devices 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 seriesRL device 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 start node for the seriesRL device toNode  The end node for the seriesRL device Exceptions: oacNodesNotInSameDesign  oacNodesNotInSameNetwork  oacNodesNotInRelatedPartitions  oacAncestorNodeWithoutId

oaEndpointType oaSeriesRL::getEndpoint (  oaNode *    node )  const

This function returns the endpoint of this device to which node is connected. Parameters: node  The node whose endPointType is to be queried Exceptions: oacDeviceNotConnectedToNode

oaNode * oaSeriesRL::getNode (  oaEndpointType    endpoint )  const

This function returns the node connected to the specified endpoint of this device. Parameters: endpoint  The endPointType of the device for which the corresponding node is to be obtained

oaNode * oaSeriesRL::getOtherNode (  oaNode *    node )  const

This function returns the node connected to the other endpoint of this device (the endpoint that is not connected to node). Parameters: node  The node connected at the other end of the device

void oaSeriesRL::getValue (  const oaAnalysisPoint *    ap, oaFloat &    resistance, oaFloat &    inductance )  const

This function gets the resistance and inductance values of this device for a particular analysis point. OpenAccess assumes resistance is specified in Ohms and inductance in Henrys. Parameters: ap  The analysis point for this device for which the resistance and inductance are to be queried resistance  A reference to an oaFloat to be populated with the resistance value in Ohms inductance  A reference to an oaFloat to be populated with the inductance value in Henrys

void oaSeriesRL::setValue (  const oaAnalysisPoint *    ap, oaFloat    resistance, oaFloat    inductance )

This function sets the resistance and inductance values of this device for a particular analysis point. OpenAccess assumes resistance is specified in Ohms and inductance in Henrys. Parameters: ap  The analysis point for this device for which the resistance and inductance are to be set resistance  An oaFloat holding the resistance value in Ohms inductance  An oaFloat holding the inductance value in Henrys

---

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

• oaSeriesRL.h
• oaSeriesRL.dox

Return to top of page

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