oaCMap.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCMap.h
//
// This file contains the definition for oaCMap class.
//
//  oaCMap
//      This class is for Congestion Map. The Congestion Map is a 
//      two-dimensional division of the chip in an array of GCells.
//      It is a collection of GCellPatterns. The congestion map 
//      definition fixes the size and aspect ratio of the individual 
//      cells of the array.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaCMap_P)
#define oaCMap_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBlock.h"



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



#define oacCMapNoCellsDefined       0xffffffffu
#define oacCMapNoSupplyDemandSet    0xffffffffu



// *****************************************************************************
// oaCMap
// *****************************************************************************
class OA_DESIGN_DLL_API oaCMap : public oaBlockObject {
public:
    static oaCMap           *getCMap(oaBlock *block);

    oaBoolean               isSupplyDemandValid() const;
    void                    deleteSupplyDemand();

    void                    getXYIndex(const oaPoint    &point,
                                       oaUInt4          &xIndex,
                                       oaUInt4          &yIndex);

    void                    getGCell(oaUInt4    xIndex,
                                     oaUInt4    yIndex,
                                     oaLayerNum layerNum,
                                     oaUInt4    &horizontalSupply,
                                     oaUInt4    &verticalSupply,
                                     oaUInt4    &upSupply,
                                     oaUInt4    &horizontalDemand,
                                     oaUInt4    &verticalDemand,
                                     oaUInt4    &upDemand) const;

    oaUInt4                 getHorizontalSupply(oaUInt4     xIndex,
                                                oaUInt4     yIndex,
                                                oaLayerNum  layerNum) const;
    oaUInt4                 getVerticalSupply(oaUInt4       xIndex,
                                              oaUInt4       yIndex,
                                              oaLayerNum    layerNum) const;
    oaUInt4                 getUpSupply(oaUInt4     xIndex,
                                        oaUInt4     yIndex,
                                        oaLayerNum  layerNum) const;
    oaUInt4                 getHorizontalDemand(oaUInt4     xIndex,
                                                oaUInt4     yIndex,
                                                oaLayerNum  layerNum) const;
    oaUInt4                 getVerticalDemand(oaUInt4       xIndex,
                                              oaUInt4       yIndex,
                                              oaLayerNum    layerNum) const;
    oaUInt4                 getUpDemand(oaUInt4     xIndex,
                                        oaUInt4     yIndex,
                                        oaLayerNum  layerNum) const;

    void                    setGCell(oaUInt4    xIndex,
                                     oaUInt4    yIndex,
                                     oaLayerNum layerNum,
                                     oaUInt4    horizontalSupply,
                                     oaUInt4    verticalSupply,
                                     oaUInt4    upSupply,
                                     oaUInt4    horizontalDemand,
                                     oaUInt4    verticalDemand,
                                     oaUInt4    upDemand);

    void                    setHorizontalSupply(oaUInt4     xIndex,
                                                oaUInt4     yIndex,
                                                oaLayerNum  layerNum,
                                                oaUInt4     horizontalSupply);
    void                    setVerticalSupply(oaUInt4       xIndex,
                                              oaUInt4       yIndex,
                                              oaLayerNum    layerNum,
                                              oaUInt4       verticalSupply);
    void                    setUpSupply(oaUInt4     xIndex,
                                        oaUInt4     yIndex,
                                        oaLayerNum  layerNum,
                                        oaUInt4     upSupply);
    void                    setHorizontalDemand(oaUInt4     xIndex,
                                                oaUInt4     yIndex,
                                                oaLayerNum  layerNum,
                                                oaUInt4     horizontalDemand);
    void                    setVerticalDemand(oaUInt4       xIndex,
                                              oaUInt4       yIndex,
                                              oaLayerNum    layerNum,
                                              oaUInt4       verticalDemand);
    void                    setUpDemand(oaUInt4     xIndex,
                                        oaUInt4     yIndex,
                                        oaLayerNum  layerNum,
                                        oaUInt4     upDemand);

    oaUInt4                 getNumXGCell() const;
    oaUInt4                 getNumYGCell() const;

    oaTimeStamp             getTimeStamp() const;

    enum {dtIndex = oacCMapDataType};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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