oaViaHeader Class Reference
Inheritance diagram for oaViaHeader:
Detailed Description
The oaViaHeader class implements an object that contains information about a particular oaViaDef and all of the vias that reference it. An oaViaHeader is an automatic object that is created and destroyed by the database. A viaHeader may be either an oaStdViaHeader or oaCustomViaHeader and is associated with standard or custom vias, respectively.
A viaHeader is automatically created whenever the first via of a particular viaDef is created. A viaHeader is destroyed when the last via using the viaDef is destroyed.
The oaViaHeader class can be observed by deriving from oaObserver<oaViaHeader>.
A discussion of the role oaViaHeader objects in the context of the oaVia objects they reference can be found in the Representing Vias in OpenAccess section of the Programmers Guide.
Member Function Documentation
| oaViaHeader * oaViaHeader::find |
( |
const oaBlock * |
block, |
|
|
const oaViaDef * |
viaDef |
|
) |
[static] |
|
|
|
This function searches the specified block for a viaHeader associated with the specified viaDef. If the viaHeader is found, it is returned. Otherwise, NULL is returned. |
| oaViaHeader * oaViaHeader::find |
( |
const oaBlock * |
block, |
|
|
const oaString & |
viaDefName |
|
) |
[static] |
|
|
|
This function searches the specified block for an viaHeader with the specified viaDef name. If the viaHeader is found, it is returned. Otherwise, NULL is returned. |
|
|
This function returns a collection of subHeaders in this superHeader. |
| oaViaDef * oaViaHeader::getViaDef |
( |
|
) |
const |
|
|
|
This function returns the viaDef object associated with this viaHeader. If the viaHeader is bound, the viaDef is returned. Otherwise, NULL is returned. |
| void oaViaHeader::getViaDefName |
( |
oaString & |
name |
) |
const |
|
|
|
This function returns the name of the viaDef associated with this viaHeader. |
|
|
This function returns the collection of vias associated with this viaHeader. |
Member Enumeration Documentation
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.
