oaRowHeader Class Reference

Inheritance diagram for oaRowHeader:

oaBlockObject oaDesignObject oaObject


Public Methods

oaSiteDef * getSiteDef () const
void getSiteDefName (oaString &siteDefName) const
oaUInt4 getSiteDefWidth () const
oaUInt4 getSiteDefHeight () const
void getBBox (oaBox &bBox) const
oaBoolean isBound () const
oaCollection< oaRow, oaRowHeader > getRows () const

Static Public Methods

oaRowHeader * find (const oaBlock *block, const oaSiteDef *siteDef)
oaRowHeader * find (const oaBlock *block, const oaString &siteDefName)

Public Types

enum  { dtIndex = oacRowHeaderDataType }

Detailed Description

The oaRowHeader class implements an object that contains information about a particular siteDef and all of the rows it uses.

The oaRowHeader class can be observed by deriving from oaObserver<oaRowHeader>.

Member Function Documentation

oaRowHeader * oaRowHeader::find (  const oaBlock *    block,
const oaString &    siteDefName
)  [static]
 

This function searches the specified block for a rowHeader with the specified siteDefName.

oaRowHeader * oaRowHeader::find (  const oaBlock *    block,
const oaSiteDef *    siteDef
)  [static]
 

This function searches the specified block for a rowHeader with the specified siteDef pointer.

void oaRowHeader::getBBox (  oaBox &    bBox )  const
 

This function fills bBox with the bounding box of all rows associated with the rowHeader. This is used to quickly determine whether any rows of the siteDef are in a region of interest. The function returns a bounding box in the coordinate space of the rowHeader's design.

oaCollection oaRowHeader::getRows (    )  const
 

This function returns a collection of rows in this rowHeader.

oaSiteDef * oaRowHeader::getSiteDef (    )  const
 

This function attempts to return the siteDef associated with this rowHeader. If the rowHeader is bound, a pointer to the siteDef is returned. Otherwise, NULL is returned.

oaUInt4 oaRowHeader::getSiteDefHeight (    )  const
 

This function returns the height of the siteDef referenced by this rowHeader.

void oaRowHeader::getSiteDefName (  oaString &    siteDefName )  const
 

This function fills in the given string with the name of the siteDef referenced by this rowHeader.

oaUInt4 oaRowHeader::getSiteDefWidth (    )  const
 

This function returns the width of the siteDef referenced by this rowHeader.

oaBoolean oaRowHeader::isBound (    )  const
 

This function returns a boolean value that indicates if this rowHeader is bound. If the rowHeader is bound, the siteDef is read in the linkage from the rowHeader and is established by traversing from a row to that siteDef.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.