oaViaVariant Class Reference

Inheritance diagram for oaViaVariant:

oaObject oaCustomViaVariant oaStdViaVariant


Public Methods

void destroy ()
void getName (oaString &name) const
oaViaDef * getViaDef () const
void getViaDefName (oaString &name) const

Static Public Methods

oaViaVariant * find (const oaObject *owner, const oaString &name, oaBoolean local=false)

Public Types

enum  { dtIndex = oacBaseViaVariantDataType }

Detailed Description

The oaViaVariant class is an abstract base class for via variants. An oaViaVariant object is a predefined parameterization of an oaStdVia or an oaCustomVia. The oaViaVariant object represents a named pairing of an oaViaDef reference and a fully specified set of via parameters.

Refer to Via Variants in the Representing Vias in OpenAccess section of the Programmers Guide for more information about via variants.

oaViaVariants can be stored in oaTech or oaDesign databases. If the oaViaVariant should be available for any design in the technology, it must be stored in a technology database. If the oaViaVariant is design specific, it should be stored in the design database.

Within a single database, each oaViaVariant must have:

If an oaViaVariant is stored in a technology database that is part of a set of incremental technology databases, then these rules apply across the graph of referenced technology databases.

Member Function Documentation

void oaViaVariant::destroy (    ) 
 

This function destroys this via variant and removes it from the database.

oaViaVariant * oaViaVariant::find (  const oaObject *    owner,
const oaString &    name,
oaBoolean    local = false
)  [static]
 

This function searches the specified database for a via variant with the specified name. If found, the via variant is returned. Otherwise NULL is returned.

The oacInvalidObjForViaVariant exception is thrown if the passed-in object pointer for owner is not a pointer to a design or technology database.

Parameters:
owner Database in which to search, either an oaTech or an oaDesign database.
name Name of the via variant to find.
local If true, look only in this technology database; If false, search this technology database and any referenced technology databases. If this argument is set to true and the owning database is a design database, this argument is ignored.
Exceptions:
oacInvalidObjForViaVariant 

void oaViaVariant::getName (  oaString &    name )  const
 

This function returns the name of this via variant.

Parameters:
name Returned name of the via variant.

oaViaDef * oaViaVariant::getViaDef (    )  const
 

This function returns a pointer to the oaViaDef associated with this via variant.

void oaViaVariant::getViaDefName (  oaString &    name )  const
 

This function returns the name of the oaViaDef associated with this via variant.

Parameters:
name Returned name of the oaViaDef.

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.