oaBlock.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBlock.h
//
// This file contains the definition for the oaBlock class and its public
// supporting classes. oaBlock is the main object for storing information about
// a level of physical hierarchy in a design. It implements methods for
// accessing all physical information in a design.
//
// The public supporting classes included here are:
//
//  oaSymmetry
//      The oaSymmetry class encapsulates the values that describe the
//      different symmetries that an oaBlock can have. 
//
//  oaBlockDomainVisibility
//      The oaBlockDomainVisibility class encapsulates the values that
//      describe the visibility of block objects in other EMH domains.
//
// *****************************************************************************
// 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(oaBlock_P)
#define oaBlock_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBox.h"
#include "oaSiteDef.h"
#include "oaTerm.h"
#include "oaDesign.h"



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



// *****************************************************************************
// oaSymmetryEnum
// *****************************************************************************
#define oavNumSymmetryTypes 5

enum oaSymmetryEnum {
    oacNoSymmetry   = 0,
    oacXSymmetry    = 1,
    oacYSymmetry    = 2,
    oacXYSymmetry   = 3,
    oacAnySymmetry  = 4
};



// *****************************************************************************
// oaSymmetry
// *****************************************************************************
class OA_DESIGN_DLL_API oaSymmetry {
public:
                            oaSymmetry(oaSymmetryEnum valueIn);
                            oaSymmetry(const oaString &name);
                            ~oaSymmetry();

    const oaString          &getName() const;

                            operator                oaSymmetryEnum() const;

private:
    oaSymmetryEnum          value;

    static const oaString   names[];
};



// *****************************************************************************
// oaBlock
// *****************************************************************************
class OA_DESIGN_DLL_API oaBlock : public oaBlockObject {
public:
    static oaBlock                          *create(const oaDesign  *design,
                                                    oaBoolean       visibleToModule = true);

    void                                    destroy();

    oaModule                                *getModule() const;
    oaUInt4                                 getDBUPerUU() const;
    oaUserUnitsType                         getUserUnits() const;
    void                                    getBBox(oaBox &bBox) const;
    void                                    getEEQMaster(oaString &master) const;
    void                                    getSitePattern(oaSitePattern &pattern) const;
    oaSymmetry                              getSymmetry() const;
    void                                    getTermsByPosition(oaTermArray &array) const;

    oaBoolean                               hasConnectivity() const;
    oaBoolean                               hasMultiBitNet() const;
    oaBoolean                               hasMultiBitTerm() const;
    oaBoolean                               hasMultiTermNet() const;
    oaBoolean                               hasGlobalNet() const;
    oaBoolean                               isVisibleToModule() const;

    void                                    setSymmetry(oaSymmetry val);
    void                                    setEEQMaster(const oaString &master);
    void                                    setSitePattern(const oaSitePattern &pattern);
    void                                    setVisibleToModule();

    oaBoolean                               hasDefaultConstraintGroup() const;
    oaConstraintGroup                       *getDefaultConstraintGroup() const;

    void                                    initForRegionQuery();

    oaCollection<oaAssignment, oaBlock>     getAssignments() const;
    oaCollection<oaBlockage, oaBlock>       getBlockages() const;
    oaCollection<oaAreaBoundary, oaBlock>   getBoundaries() const;
    oaCollection<oaBusNetDef, oaBlock>      getBusNetDefs() const;
    oaCollection<oaBusTermDef, oaBlock>     getBusTermDefs() const;
    oaCollection<oaConnectDef, oaBlock>     getConnectDefs() const;
    oaCollection<oaCluster, oaBlock>        getClusters() const;
    oaCollection<oaFigGroup, oaBlock>       getFigGroups() const;
    oaCollection<oaGCellPattern, oaBlock>   getGCellPatterns() const;
    oaCollection<oaGuide, oaBlock>          getGuides() const;
    oaCollection<oaInstHeader, oaBlock>     getInstHeaders() const;
    oaCollection<oaInst, oaBlock>           getInsts(oaUInt4 filterFlags = oacInstIterNotImplicit) const;
    oaCollection<oaInstTerm, oaBlock>       getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaLPPHeader, oaBlock>      getLPPHeaders() const;
    oaCollection<oaLayerHeader, oaBlock>    getLayerHeaders() const;
    oaCollection<oaMarker, oaBlock>         getMarkers() const;
    oaCollection<oaPin, oaBlock>            getPins() const;
    oaCollection<oaNet, oaBlock>            getNets(oaUInt4 filterFlags = oacNetIterAll | oacNetIterNotImplicit) const;
    oaCollection<oaRoute, oaBlock>          getRoutes() const;
    oaCollection<oaRowHeader, oaBlock>      getRowHeaders() const;
    oaCollection<oaRow, oaBlock>            getRows() const;
    oaCollection<oaScanChain, oaBlock>      getScanChains() const;
    oaCollection<oaShape, oaBlock>          getShapes() const;
    oaCollection<oaSteiner, oaBlock>        getSteiners() const;
    oaCollection<oaTerm, oaBlock>           getTerms(oaUInt4 filterFlags = oacTermIterAllNotHidden | oacTermIterNotImplicit) const;
    oaCollection<oaTrackPattern, oaBlock>   getTrackPatterns() const;
    oaCollection<oaVectorInstDef, oaBlock>  getVectorInstDefs() const;
    oaCollection<oaVia, oaBlock>            getVias() const;
    oaCollection<oaViaHeader, oaBlock>      getViaHeaders() const;

    enum {dtIndex = oacBlockDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaBlock> {
public:
    typedef oaBlockObject       parentType;
    typedef oaBlockModTypeEnum  modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacBlockDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacBlockType};
    enum {dataTypeEnumVal = oacBlockDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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