oaInstQuery Class Reference

Inheritance diagram for oaInstQuery:

oaRegionQuery


Public Methods

 oaInstQuery ()
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 queryInst (oaInst *inst)=0

Detailed Description

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

Constructor & Destructor Documentation

oaInstQuery::oaInstQuery (    ) 
 

This is the constructor for the oaInstQuery class.

Member Function Documentation

void oaInstQuery::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 instances 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 transform that is currently 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 end the querying.

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

This function begins the query process to start generating instances 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 end the querying.

void oaInstQuery::queryInst (  oaInst *    inst )  [pure virtual]
 

This function processes each result of the instance query.

Parameters:
inst Pointer to an instance found during querying.

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.