oaRefHeader Class Reference

Inheritance diagram for oaRefHeader:

oaBlockObject oaDesignObject oaObject oaInstHeader oaViaHeader oaCustomViaHeader oaStdViaHeader


Public Methods

oaDesign * getMaster () const
void getMasterBBox (oaBox &bBox) const
void getBBox (oaBox &bBox) const
oaRefHeader * getSuperHeader () const
oaBoolean isBound () const
oaBoolean isSuperHeader () const
oaBoolean isSubHeader () const

Detailed Description

The oaRefHeader class is an abstract base class that encapsulates information about a particular design master referenced in another design and all of the instances or vias that use it. The oaRefHeader class is the base of oaInstHeader and oaViaHeader.

Member Function Documentation

void oaRefHeader::getBBox (  oaBox &    bBox )  const
 

This function fills out 'bBox' with the bBox of this instHeader.

Parameters:
bBox The calculated bBox.

oaDesign * oaRefHeader::getMaster (    )  const
 

This function attempts to return the master associated with the specified refHeader. If the master is not bound, OpenAccess will attempt to bind the master. If the refHeader cannot be bound, NULL will be returned.

Note, binding will not be attempted if the database containing the refHeader is currently being purged.

void oaRefHeader::getMasterBBox (  oaBox &    bBox )  const
 

This function fills out 'bBox' with the bBox of this refHeader's master. Note that if the master's bBox is inverted (because the master is empty), it will be set to zero.

Parameters:
bBox The calculated bBox of the master.

oaRefHeader * oaRefHeader::getSuperHeader (    )  const
 

This function returns the superHeader of this refHeader or NULL if it is not a subHeader.

oaBoolean oaRefHeader::isBound (    )  const
 

This function returns a boolean indicating whether or not this refHeader is bound.

oaBoolean oaRefHeader::isSubHeader (    )  const
 

This function returns a boolean indicating whether or not this refHeader is a subHeader.

oaBoolean oaRefHeader::isSuperHeader (    )  const
 

This function returns a boolean indicating whether or not this refHeader is a superHeader.

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.