oaStdVia Class Reference

Inheritance diagram for oaStdVia:


Public Methods
oaStdViaHeader *	getHeader () const
void	getViaParams (oaViaParam &params) const
void	setViaParams (const oaViaParam &params)
Static Public Methods
oaStdVia *	create (oaBlock block, const oaStdViaDef viaDef, const oaTransform &xform, const oaViaParam *params=NULL)

Detailed Description

The oaStdVia class implements an object that represents a standard via. A standard via is an instance of a standard via definition which is implemented by the oaStdViaDef object. There are a fixed number of parameters whose values can be customized. These parameters are specified through an oaViaParam object.

A standard via may be used as object associated with an oaRoute.

A discussion of the creation of oaStdVia objects can be found in the Representing Vias in OpenAccess section of the Programmers Guide.

Member Function Documentation

oaStdVia * oaStdVia::create ( oaBlock * block,

const oaStdViaDef * viaDef,

const oaTransform & xform,

const oaViaParam * params = NULL

) [static]

This function creates a standard via with the specified attributes. The non-default parameter values from params override the baseline set of parameters associated with viaDef.
An exception is thrown if the via to be created uses an oaViaDef from a technology database that is not included in the referenced graph of technology databases for the technology database bound to the design containing the via.
An exception is thrown if the via to be created uses an oaStdViaDef with the same name as an existing customViaHeader.

Parameters:

block The block in which to create the standard via.

viaDef The oaStdViaDef to reference; the standard via parameters related to the oaStdViaDef (those used to create the oaStdViaDef) establish a baseline default set of parameter values used to create the standard via.

xform The transform to apply to the standard via.

params A set of via parameter settings to override the baseline default parameters from the oaStdViaDef. A NULL value specifies that the default values are to be used. If params is not NULL, only non-default values will be applied. If the default flag bit for a parameter from params is set, the corresponding parameter from the oaStdViaDef is used in the creation of the via.

Exceptions:

oacViaDefNotInTechAssociatedWithDesign

oacStdViaDefSameNameAsCustomViaDef

oaStdViaHeader * oaStdVia::getHeader ( ) const

This function returns the standard via header associated with this standard via.
Reimplemented from oaVia.

void oaStdVia::getViaParams ( oaViaParam & params ) const

This function returns the standard via parameters associated with this standard via in the given params argument.

void oaStdVia::setViaParams ( const oaViaParam & params )

This function changes the values of the standard via parameters associated with this standard via. Only the non-default values from params are applied. If the default flag bit for a parameter is set, the baseline default parameter value from the oaStdViaDef object used to create the oaStdVia object is applied.

The documentation for this class was generated from the following files:

Return to top of page

oaStdVia Class Reference

Public Methods

Static Public Methods

Detailed Description

Member Function Documentation