oaFigGroupQuery Class Reference

Inheritance diagram for oaFigGroupQuery:

oaRegionQuery


Public Methods

 oaFigGroupQuery ()
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 queryFigGroup (oaFigGroup *figGroup)=0

Detailed Description

The oaFigGroupQuery class implements functionality to query a specified region in a design hierarchy and quickly return all oaFigGroups that overlap the region. This class is abstract, and an application must derive its own sub-class.

Constructor & Destructor Documentation

oaFigGroupQuery::oaFigGroupQuery (    ) 
 

This is the constructor for the oaFigGroupQuery class.

Member Function Documentation

void oaFigGroupQuery::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 figGroups 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 in which to perform the query.
xform The current transform that is applied to the design.
filterSize Specifies query objects with a size equal to or larger than this value.
startLevel The level of the block hierarchy to start the query.
stopLevel The level of the block hierarchy to stop the query.

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

This function begins the query process to start generating figGroups 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 in which to perform the query.
filterSize Specifies query objects with a size equal to or larger than this value.
startLevel The level of the block hierarchy to start the query.
stopLevel The level of the block hierarchy to stop the query.

void oaFigGroupQuery::queryFigGroup (  oaFigGroup *    figGroup )  [pure virtual]
 

This function processes each result of the figGroup query.

Parameters:
figGroup The pointer to the oaFigGroup that is 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.