oaSteinerQuery Class Reference

Inheritance diagram for oaSteinerQuery:

oaRegionQuery


Public Methods

 oaSteinerQuery ()
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 querySteiner (oaSteiner *steiner)=0

Detailed Description

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

Constructor & Destructor Documentation

oaSteinerQuery::oaSteinerQuery (    ) 
 

The constructor for the oaSteinerQuery.

Member Function Documentation

oaLayerNum oaSteinerQuery::getLayerNum (    )  const
 

This function returns the layer number associated with this steiner query.

void oaSteinerQuery::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 steiners in the specified region of the specified design hierarchy. This function only generates steiners that are not attached to any layers.

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 oaSteinerQuery::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 steiners on the specified region of the specified design hierarchy. specified layer, in the specified region of the specified design hierarchy. specified layer in the specified region of the specified design hierarchy.

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

This function begins the query process to start generating steiners in the specified region of the specified design hierarchy. This function only generates steiners that are not attached to any layers.

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 oaSteinerQuery::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 steiners on the specified layer in the specified region of the specified design hierarchy.

Parameters:
topDesign Pointer to the top design in which to perform the query.
layerNum Only query objects that have 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 oaSteinerQuery::querySteiner (  oaSteiner *    steiner )  [pure virtual]
 

The function processes each result of the steiner query.

Parameters:
steiner Pointer to the oaSteiner 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.