oaGroundedNode Class Reference

Inheritance diagram for oaGroundedNode:

oaNode oaDesignObject oaObject


Public Methods

void setValue (const oaAnalysisPoint *ap, oaFloat value)
oaFloat getValue (const oaAnalysisPoint *ap) const

Static Public Methods

oaGroundedNode * create (oaParasiticNetwork *network)
oaGroundedNode * create (oaParasiticNetwork *network, oaUInt4 id)

Detailed Description

The oaGroundedNode class is used for nodes contained within an oaParasiticNetwork that include capacitance to an implicit ground. Each grounded node has one value for each analysis point that the parasitic network represents. Each value reflects the capacitance value applicable to the operating points associated with the corresponding analysis point.

Member Function Documentation

oaGroundedNode * oaGroundedNode::create (  oaParasiticNetwork *    network,
oaUInt4    id
)  [static]
 

This function creates a grounded node belonging to the specified parasitic network. An explicit unique node ID 'id' is required to be specified. An exception will be thrown if the 'id' is the reserved oacInvalidNodeID value or if a node with the specified 'id' value already exists. The hasId() function will return true for nodes created with these functions and the getId() function will return the user-specified node id.

Parameters:
network The parasitic network to which the created node will belong
id A unique ID to be associated with the node
Exceptions:
oacNodeIdExists 
oacInvalidNodeIdSpecified 

Reimplemented from oaNode.

oaGroundedNode * oaGroundedNode::create (  oaParasiticNetwork *    network )  [static]
 

This function creates a grounded node belonging to the specified parasitic network. The node created does not have an ID associated with it. The hasId() function will return false for these nodes and the getId() function will return an oacInvalidNodeID value.

Parameters:
network The parasitic network to which the created node will belong

Reimplemented from oaNode.

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

This function gets the capacitance value of this node for a particular analysis point.

OpenAccess assumes capacitance data is specified in Farads

Parameters:
ap The reference analysis point to use to obtain the capacitance value

oaFloat oaGroundedNode::setValue (  const oaAnalysisPoint *    ap,
oaFloat    value
) 
 

This function sets the capacitance value of this node for a particular analysis point.

OpenAccess assumes capacitance data is specified in Farads

Parameters:
ap The reference analysis point for which the capacitance value needs to be set
value The capacitance value in Farads

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.