oaStdViaVariant Class Reference

Inheritance diagram for oaStdViaVariant:

oaViaVariant oaObject


Public Methods

void getParams (oaViaParam &params) const

Static Public Methods

oaStdViaVariant * create (oaObject *owner, const oaString &name, const oaStdViaDef *viaDef, const oaViaParam &params)
oaStdViaVariant * find (const oaObject *owner, const oaStdViaDef *viaDef, const oaViaParam &params, oaBoolean local=false)

Detailed Description

The oaStdViaVariant class implements a standard via variant, which represents a predefined standard via parameterization.

An oaStdViaVariant is comprised of

An oaStdViaVariant 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

oaStdViaVariant * oaStdViaVariant::create (  oaObject *    owner,
const oaString &    name,
const oaStdViaDef *    viaDef,
const oaViaParam &    params
)  [static]
 

This function creates a standard 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 oacAllParamsNeededForViaVariant exception is thrown if all of the parameters need for the standard via variant are not explicitly specified.

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 oaDesign database.
name Name for this standard via variant.
viaDef Pointer to the oaStdViaDef to use.
params Set of via parameters in which all values are specified.
Exceptions:
oacInvalidObjForViaVariant 
oacViaVariantNameExists 
oacAllParamsNeededForViaVariant 
oacViaVariantViaDefParamExists 

oaStdViaVariant * oaStdViaVariant::find (  const oaObject *    owner,
const oaStdViaDef *    viaDef,
const oaViaParam &    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 Standard via definition used by the oaStdViaVariant being searched for.
params Set of via parameters used by the oaStdViaVariant being searched for. All parameters in the oaViaParam class are used for matching (the values of both the specified and the unspecified parameters are used).
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 oaStdViaVariant::getParams (  oaViaParam &    params )  const
 

This function returns the via parameters associated with this standard via variant.

Parameters:
params Returned 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.