oaCustomViaVariant Class Reference

Inheritance diagram for oaCustomViaVariant:

oaViaVariant oaObject


Public Methods

void getParams (oaParamArray &params) const

Static Public Methods

oaCustomViaVariant * create (oaObject *owner, const oaString &name, const oaCustomViaDef *viaDef, const oaParamArray &params)
oaCustomViaVariant * find (const oaObject *owner, const oaCustomViaDef *viaDef, const oaParamArray &params, oaBoolean local=false)

Detailed Description

The oaCustomViaVariant class implements a custom via variant, which represents a predefined custom via parameterization.

An oaCustomViaVariant is comprised of

An oaCustomViaVariant can be created in a design database if it applies to specific design, or in a technology database if it should be available to multiple designs.

Member Function Documentation

oaCustomViaVariant * oaCustomViaVariant::create (  oaObject *    owner,
const oaString &    name,
const oaCustomViaDef *    viaDef,
const oaParamArray &    params
)  [static]
 

This function creates a custom via variant with the specified attributes.

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

An oacViaVariantNameExists exception is thrown if the specified name is already used by an existing via variant.

An oacViaVariantViaDefParamExists exception is thrown if the database already contains a via variant which matches the specified viaDef/params combination.

Parameters:
owner Database in which to create the standard via variant, either an oaTech or an oaDesign database.
name Name for this custom via variant.
viaDef Pointer to the oaCustomViaDef to use.
params Array of parameters for the custom via variant.
Exceptions:
oacInvalidObjForViaVariant 
oacViaVariantNameExists 
oacViaVariantViaDefParamExists 

oaCustomViaVariant * oaCustomViaVariant::find (  const oaObject *    owner,
const oaCustomViaDef *    viaDef,
const oaParamArray &    params,
oaBoolean    local = false
)  [static]
 

This function searches the specified database for a via variant with the specified oaViaDef and parameter combination. 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 Pointer to the owning database in which to search.
viaDef Custom via definition used by the oaCustomViaVariant being searched for.
params Array of parameters for the custom via variant. All parameters must be specified for the find() to succeed. This function does not assume that unspecified parameters match existing parameters.
local If true, look only in the specified database; If false, search the specified database and any referenced databases. If this argument is set to true and the owning database is a design database, this argument is ignored.
Exceptions:
oacInvalidObjForViaVariant 

void oaCustomViaVariant::getParams (  oaParamArray &    params )  const
 

This function returns the array of via parameters for this custom via variant.

Parameters:
params Returned array of via parameters.

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.