oaViaDef Class Reference

Inheritance diagram for oaViaDef:

oaTechObject oaObject oaCustomViaDef oaStdViaDef


Public Methods

void destroy ()
void getName (oaString &name) const
void getLayers (oaPhysicalLayer *&layer1, oaPhysicalLayer *&layer2) const
oaPhysicalLayer * getLayer1 () const
oaPhysicalLayer * getLayer2 () const
oaLayerNum getLayer1Num () const
oaLayerNum getLayer2Num () const
oaFloat getResistancePerCut () const
oaBoolean hasLayer (oaLayerNum layerNum) const
void setResistancePerCut (oaFloat resPerCut)
oaCollection< oaViaHeader, oaViaDef > getUsedIn () const

Static Public Methods

oaViaDef * find (const oaTech *tech, const oaString &name)
oaViaDef * find (const oaTech *tech, const oaString &name, oaBoolean local)

Public Types

enum  { dtIndex = oacViaDefDataType }

Detailed Description

The oaViaDef class implements an oaViaDef object. An oaViaDef object defines a via design in a technology database. A via in a route must point to an oaViaDef object in the technology database associated with the design where the route resides.

The oaViaDef class can be observed by deriving from oaObserver<oaViaDef>.

For information about creating oaViaDef objects and using them in the creation of vias, refer to Representing Vias in OpenAccess in the Programmers Guide.

Member Function Documentation

void oaViaDef::destroy (    ) 
 

This function destroys this viaDef, removing it from the technology database.

oaViaDef * oaViaDef::find (  const oaTech *    tech,
const oaString &    name,
oaBoolean    local
)  [static]
 

This function searches for a viaDef with the specified name. The local argument specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases. If found, the viaDef is returned, otherwise NULL is returned.

Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases.

Parameters:
tech The technology database to search
name Name of the viaDef to find
local Specifies whether (if true) to look only in the specified technology database or (if false) to look in the specified technology database and all of its referenced databases.

oaViaDef * oaViaDef::find (  const oaTech *    tech,
const oaString &    name
)  [static]
 

This function searches the technology database for a viaDef with the specified name. If the specified technology database references other technology databases, those are searched as well and the first matching viaDef is returned. To find a viaDef in the current technology database only, refer to the find overload that accepts the local argument.

This function returns the viaDef, if found. Otherwise, NULL is returned.

Refer to Incremental Technology Databases in the Using Technology Databases section of the Programmers Guide for more information about referenced tech databases.

Parameters:
tech Tech database to search
name Name of the viaDef to find

oaLayer * oaViaDef::getLayer1 (    )  const
 

This function returns the first layer associated with this viaDef.

To get the layer1 number associated with this viaDef even if the tech database containing the layer is unbound, refer to getLayer1Num.

oaLayerNum oaViaDef::getLayer1Num (    )  const
 

This function returns the layer1 number associated with this viaDef, even if the tech database containing the layer is unbound.

oaLayer * oaViaDef::getLayer2 (    )  const
 

This function returns the second layer associated with this viaDef.

To get the layer2 number associated with this viaDef even if the tech database containing the layer is unbound, refer to getLayer2Num.

oaLayerNum oaViaDef::getLayer2Num (    )  const
 

This function returns the layer2 number associated with this viaDef, even if the tech database containing the layer is unbound.

void oaViaDef::getLayers (  oaPhysicalLayer *&    layer1,
oaPhysicalLayer *&    layer2
)  const
 

This function fills out layer1 and layer2 with the physical layers associated with this viaDef object.

void oaViaDef::getName (  oaString &    name )  const
 

This function fills out name with the name of this viaDef.

oaFloat oaViaDef::getResistancePerCut (    )  const
 

This function returns the resistancePerCut attribute on this viaDef. The oaFloat return value specifies resistance in Ohms.

oaCollection oaViaDef::getUsedIn (    )  const
 

This function returns a collection of viaHeaders in all open designs that refer to this viaDef object.

oaBoolean oaViaDef::hasLayer (  oaLayerNum    layerNum )  const
 

This function returns a boolean value that indicates if this viaDef is associated with the layer of the specified layer number.

void oaViaDef::setResistancePerCut (  oaFloat    resPerCut ) 
 

This function sets the resistancePerCut attribute on this viaDef. The resPerCut value should be specified in Ohms.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.