oaCustomViaHeader Class Reference

Inheritance diagram for oaCustomViaHeader:

oaViaHeader oaRefHeader oaBlockObject oaDesignObject oaObject


Public Methods

void getLibName (oaScalarName &libName) const
void getCellName (oaScalarName &cellName) const
void getViewName (oaScalarName &viewName) const
void getLibName (const oaNameSpace &ns, oaString &libName) const
void getCellName (const oaNameSpace &ns, oaString &cellName) const
void getViewName (const oaNameSpace &ns, oaString &viewName) const
void getParams (oaParamArray &params) const
void getAllParams (oaParamArray &params) const

Detailed Description

The oaCustomViaHeader class implements an object that contains information about custom vias of a particular oaCustomViaDef object used in a design. For designs containing custom vias of oaCustomViaDefs that are associated with a parameterized master design, there are two kinds of customViaHeaders:

Every custom via of a Pcell has exactly one subHeader, which, in turn, has exactly one superHeader. CustomViaHeaders for instances that are not Pcells are neither subheaders nor superheaders.

Member Function Documentation

void oaCustomViaHeader::getAllParams (  oaParamArray &    params )  const
 

This function fills out params with the complete set of parameters associated with this customViaHeader. The paramArray will contain the params for which this via uses default values and the params for which it uses override values. If this viaHeader is not associated with a Pcell via master, params will have a numParams of zero.

void oaCustomViaHeader::getCellName (  const oaNameSpace &    ns,
oaString &    cellName
)  const
 

This function returns the cell name of the master oaDesign referenced by this customViaHeader.

Parameters:
ns The namespace in which to return the cell name.
cellName The returned cell name.

void oaCustomViaHeader::getCellName (  oaScalarName &    cellName )  const
 

This function returns the cell name of the master oaDesign referenced by this customViaHeader.

Parameters:
cellName The returned cell name.

void oaCustomViaHeader::getLibName (  const oaNameSpace &    ns,
oaString &    libName
)  const
 

This function returns the library name of the master oaDesign referenced by this customViaHeader.

Parameters:
ns The namespace in which to return the library name.
libName The returned library name.

void oaCustomViaHeader::getLibName (  oaScalarName &    libName )  const
 

This function returns the library name of the master oaDesign referenced by this customViaHeader.

Parameters:
libName The returned library name.

void oaCustomViaHeader::getParams (  oaParamArray &    params )  const
 

This function fills out params with the parameters associated with this customViaHeader. This call only returns the non-default parameters that were specified during creation or through calls to setParams() on the custom vias. If this viaHeader is not associated with a Pcell via master or uses all default parameters, params will have a numParams of zero.

void oaCustomViaHeader::getViewName (  const oaNameSpace &    ns,
oaString &    viewName
)  const
 

This function returns the view name of the master oaDesign referenced by this customViaHeader.

Parameters:
ns The namespace in which to return the view name.
viewName The returned view name.

void oaCustomViaHeader::getViewName (  oaScalarName &    viewName )  const
 

This function returns the view name of the master oaDesign referenced by this customViaHeader.

Parameters:
viewName The returned view name.

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.