oaRowQuery Class Reference

Inheritance diagram for oaRowQuery:

oaRegionQuery


Public Methods

 oaRowQuery ()
void query (oaDesign *topDesign, const oaBox &region, oaDist filterSize=0, oaUInt4 startLevel=0, oaUInt4 stopLevel=100)
void query (oaDesign *topDesign, const oaBox &region, const oaTransform &xform, oaDist filterSize=0, oaUInt4 startLevel=0, oaUInt4 stopLevel=100)
virtual void queryRow (oaRow *row)=0

Detailed Description

The oaRowQuery class implements functionality to query a specified region in a design hierarchy and quickly return all rows that overlap the region.

Constructor & Destructor Documentation

oaRowQuery::oaRowQuery (    ) 
 

The constructor of oaRowQuery.

Member Function Documentation

void oaRowQuery::query (  oaDesign *    topDesign,
const oaBox &    region,
const oaTransform &    xform,
oaDist    filterSize = 0,
oaUInt4    startLevel = 0,
oaUInt4    stopLevel = 100
) 
 

This function begins the query process to start generating rows in the specified region of the specified design hierarchy.

Parameters:
topDesign Pointer to the top design in which to perform the query.
region The region of interest.
xform The current transform that is applied to the design.
filterSize Only query objects whose size is equal to or larger than filterSize.
startLevel The level of block hierarchy to start the querying.
stopLevel The level of block hierarchy to start the querying.

void oaRowQuery::query (  oaDesign *    topDesign,
const oaBox &    region,
oaDist    filterSize = 0,
oaUInt4    startLevel = 0,
oaUInt4    stopLevel = 100
) 
 

This function begins the query process to start generating rows in the specified region of the specified design hierarchy.

Parameters:
topDesign Pointer to the top design in which to perform the query.
region The region of interest.
filterSize Only query objects whose size is equal to or larger than filterSize.
startLevel The level of block hierarchy to start the querying.
stopLevel The level of block hierarchy to stop the querying.

void oaRowQuery::queryRow (  oaRow *    row )  [pure virtual]
 

This function processes each result of the row query.

Parameters:
row Pointer to the oaRow object that is being queried

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.