oaGuideQuery Class Reference

Inheritance diagram for oaGuideQuery:

oaRegionQuery


Public Methods

 oaGuideQuery ()
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 queryGuide (oaGuide *guide)=0

Detailed Description

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

Constructor & Destructor Documentation

oaGuideQuery::oaGuideQuery (    ) 
 

The constructor for oaGuideQuery.

Member Function Documentation

void oaGuideQuery::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 guides 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 stop the querying.

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

This function begins the query process to start generating guides 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 oaGuideQuery::queryGuide (  oaGuide *    guide )  [pure virtual]
 

This function processes each result of the guide query.

Parameters:
guide Pointer to the oaGuide 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.