oaRegionQuery.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaRegionQuery.h
//
// This file contains the definitions for the public regionQuery classes. These
// classes implement functionality to query a specified region in a design
// hierarchy and quickly return objects of a specified type that overlap the
// region. These classes are all abstract; applications must derive their own
// sub-classes to use them. The classes implemented include:
//
//  oaRegionQuery
//      This is the common base class for all types of query objects.
//
// Derived query classes for specific types of figures include:
//      oaBlockageQuery
//      oaBoundaryQuery
//      oaFigGroupQuery
//      oaGuideQuery
//      oaInstQuery
//      oaLayerRangeBlockageQuery
//      oaMarkerQuery
//      oaPlacementBlockageQuery
//      oaRowQuery 
//      oaShapeQuery
//      oaSteinerQuery
//      oaViaQuery
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaRegionQuery_P)
#define oaRegionQuery_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaVia.h"
#include "oaGuide.h"
#include "oaRow.h"
#include "oaMarker.h"
#include "oaBoundary.h"
#include "oaBlockage.h"
#include "oaSteiner.h"
#include "oaOccShape.h"
#include "oaFigGroup.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE

class IRegionQueryPlugMgr;



// *****************************************************************************
// oaRegionQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaRegionQuery {
public:
    virtual                     ~oaRegionQuery();       
    const oaDesign              *getTopDesign() const;
    const oaBox                 &getRegion() const;
    const oaTransform           &getCurrentTransform() const;
    const oaBox                 &getCurrentRegion() const;
    void                        getHierPath(oaHierPath &hierPath) const;
    oaDist                      getFilterSize() const;
    oaUInt4                     getStartLevel() const;
    oaUInt4                     getStopLevel() const;

    void                        abort();

    virtual oaBoolean           startRef(oaRef      *ref,
                                         oaUInt4    row = 0,
                                         oaUInt4    col = 0);
    virtual void                endRef(oaRef    *ref,
                                       oaUInt4  row = 0,
                                       oaUInt4  col = 0);

    static void                 init(const oaString &plugInName);
    static void                 getPlugInName(oaString &plugInName);
    static IRegionQueryPlugMgr  *getMgr();

protected:
                                oaRegionQuery();
                                oaRegionQuery(const oaRegionQuery &);

    static IRegionQueryPlugMgr  *rqMgr;
    oaRegionQueryPvt            *pvt;

    friend class oaBlockTbl;

private:
    oaRegionQuery               &operator=(const oaRegionQuery &);
};



// *****************************************************************************
// oaBlockageQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaBlockageQuery : public oaRegionQuery {
public:
                            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;
};



// *****************************************************************************
// oaBoundaryQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaBoundaryQuery : public oaRegionQuery {
public:
                            oaBoundaryQuery();

    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            queryBoundary(oaBoundary *boundary) = 0;
};



// *****************************************************************************
// oaFigGroupQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaFigGroupQuery : public oaRegionQuery {
public:
                            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;
};



// *****************************************************************************
// oaGuideQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaGuideQuery : public oaRegionQuery {
public:
                            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;
};



// *****************************************************************************
// oaInstQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstQuery : public oaRegionQuery {
public:
                            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;
};



// *****************************************************************************
// oaLayerRangeBlockageQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaLayerRangeBlockageQuery : public oaRegionQuery {
public:
                            oaLayerRangeBlockageQuery();

    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            queryBlockage(oaBlockage *blockage) = 0;
};



// *****************************************************************************
// oaMarkerQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaMarkerQuery : public oaRegionQuery {
public:
                            oaMarkerQuery();

    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            queryMarker(oaMarker *marker) = 0;
};



// *****************************************************************************
// oaPlacementBlockageQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaPlacementBlockageQuery : public oaRegionQuery {
public:
                            oaPlacementBlockageQuery();

    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            queryBlockage(oaBlockage *blockage) = 0;
};



// *****************************************************************************
// oaRowQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaRowQuery : public oaRegionQuery {
public:
                            oaRowQuery();

    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            queryRow(oaRow *row) = 0;
};



// *****************************************************************************
// oaShapeQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaShapeQuery : public oaRegionQuery {
public:
                            oaShapeQuery();

    oaLayerNum              getLayerNum() const;
    oaPurposeNum            getPurposeNum() const;

    void                    query(oaDesign      *topDesign,
                                  oaLayerNum    layerNum,
                                  oaPurposeNum  purposeNum,
                                  const oaBox   &region,
                                  oaDist        filterSize = 0,
                                  oaUInt4       startLevel = 0,
                                  oaUInt4       stopLevel = 100);
    void                    query(oaDesign          *topDesign,
                                  oaLayerNum        layerNum,
                                  oaPurposeNum      purposeNum,
                                  const oaBox       &region,
                                  const oaTransform &xform,
                                  oaDist            filterSize = 0,
                                  oaUInt4           startLevel = 0,
                                  oaUInt4           stopLevel = 100);

    oaOccShape              *getOccShape(oaShape *shape) const;

    virtual void            queryShape(oaShape *shape) = 0;
};



// *****************************************************************************
// oaSteinerQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaSteinerQuery : public oaRegionQuery {
public:
                            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;
};



// *****************************************************************************
// oaViaQuery
// *****************************************************************************
class OA_DESIGN_DLL_API oaViaQuery : public oaRegionQuery {
public:
                            oaViaQuery();

    oaLayerNum              getLayerNum1() const;
    oaLayerNum              getLayerNum2() const;

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

    virtual void            queryVia(oaVia *via) = 0;
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.