oaBlockageQuery Class Reference

Inheritance diagram for oaBlockageQuery:

oaRegionQuery


Public Methods

 oaBlockageQuery ()
oaLayerNum getLayerNum () const
void query (oaDesign *topDesign, oaLayerNum layerNum, const oaBox &region, oaDist filterSize=0, oaUInt4 startLevel=0, oaUInt4 stopLevel=100)
void query (oaDesign *topDesign, const oaBox &region, oaDist filterSize=0, oaUInt4 startLevel=0, oaUInt4 stopLevel=100)
void query (oaDesign *topDesign, oaLayerNum layerNum, const oaBox &region, const oaTransform &xform, 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 queryBlockage (oaBlockage *blockage)=0
virtual void queryPlacementBlockage (oaBlockage *blockage)=0

Detailed Description

This class allows the caller to query a specified region in a design hierarchy and return blockage objects that overlap the region. This is an abstract class. Applications must derive their own sub-class to use it.

Constructor & Destructor Documentation

oaBlockageQuery::oaBlockageQuery (    ) 
 

This is the constructor for oaBlockQuery.

Member Function Documentation

oaLayerNum oaBlockageQuery::getLayerNum (    )  const
 

This function returns the layer number that is associated with the current query.

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

Note: This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the oaPlacementBlockageQuery class and query functions on oaPlacementBlockageQuery instead.

This function begins the query process to start generating placement blockages in the specified region of the specified design hierarchy. Only oaAreaBlockage objects and oaAreaHalo objects in the design hierarchy will be produced. For every blockage object that is produced, the virtual function queryPlacementBlockage() gets called.

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 oaBlockageQuery::query (  oaDesign *    topDesign,
oaLayerNum    layerNum,
const oaBox &    region,
const oaTransform &    xform,
oaDist    filterSize = 0,
oaUInt4    startLevel = 0,
oaUInt4    stopLevel = 100
) 
 

This function begins the query process to start generating blockages on the specified layer in the specified region of the specified design hierarchy. This query produces oaLayerBlockage objects, oaLayerHalo objects oaLayerRangeBlockage and oaLayerRangeHalo objects in the design hierachy. oaLayerRangeBlockage and oaLayerRangeHalo objects are produced if the layer's mask number falls within the maskRange of these objects. For every blockage object that is produced, the virtual function queryBlockage() gets called.

Parameters:
topDesign Pointer to the top design in which to perform the query.
layerNum Only query objects with this layer number.
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 oaBlockageQuery::query (  oaDesign *    topDesign,
const oaBox &    region,
oaDist    filterSize = 0,
oaUInt4    startLevel = 0,
oaUInt4    stopLevel = 100
) 
 

Note: This function is deprecated and is retained to ensure compatibility with previous versions of OpenAccess. Use the oaPlacementBlockageQuery class and query functions on oaPlacementBlockageQuery instead.

This function begins the query process to start generating placement blockages in the specified region of the specified design hierarchy. Only oaAreaBlockage objects and oaAreaHalo objects in the design hierarchy will be produced. For every blockage object that is produced, the virtual function queryPlacementBlockage() gets called.

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 oaBlockageQuery::query (  oaDesign *    topDesign,
oaLayerNum    layerNum,
const oaBox &    region,
oaDist    filterSize = 0,
oaUInt4    startLevel = 0,
oaUInt4    stopLevel = 100
) 
 

This function begins the query process to start generating blockages on the specified layer in the specified region of the specified design hierarchy. This query produces oaLayerBlockage objects, oaLayerHalo objects oaLayerRangeBlockage and oaLayerRangeHalo objects in the design hierachy. oaLayerRangeBlockage and oaLayerRangeHalo objects are produced if the layer's mask number falls within the maskRange of these objects. For every blockage object that is produced, the virtual function queryBlockage() gets called.

Parameters:
topDesign Pointer to the top design in which to perform the query.
layerNum Only query objects who has this layer number.
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 oaBlockageQuery::queryBlockage (  oaBlockage *    blockage )  [pure virtual]
 

This function processes each result of the blockage query. This gets called during queries based on a layer number. The specified blockage can be oaLayerBlockage, oaLayerHalo, oaLayerRangeBlockages or oaLayerRangeHalo.

Parameters:
blockage The pointer to the oaBlockage queried.

void oaBlockageQuery::queryPlacementBlockage (  oaBlockage *    blockage )  [pure virtual]
 

This function processes each result of the blockage query. This gets called during queries for placement blockages. The specified blockage can be oaAreaBlockage, oaAreaHalo.

Parameters:
blockage Pointer to the oaBlockage 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.