oaPhysicalLayer.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPhysicalLayer.h
//
// This file contains the definition for the oaPhysicalLayer class and its
// public supporting classes. The oaPhysicalLayer class defines a physical
// layer which is referenced when creating physical design data. The supporting
// classes include:
//
//  oaPrefRoutingDir
//      This class implements an enumerated type that describes the preferred
//      routing direction for a layer.
//
//  oaMaterial
//      This class implements an enumerated type that describes the material
//      type used by a layer.
//
//
// *****************************************************************************
// 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(oaPhysicalLayer_P)
#define oaPhysicalLayer_P



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



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



// *****************************************************************************
// oaPrefRoutingDirEnum
// *****************************************************************************
#define oavNumPrefRoutingDirTypes   6

enum oaPrefRoutingDirEnum {
    oacNotApplicablePrefRoutingDir  = 0,
    oacNonePrefRoutingDir           = 1,
    oacHorzPrefRoutingDir           = 2,
    oacVertPrefRoutingDir           = 3,
    oacLeftDiagPrefRoutingDir       = 4,
    oacRightDiagPrefRoutingDir      = 5
};



// *****************************************************************************
// oaPrefRoutingDir
// *****************************************************************************
class OA_TECH_DLL_API oaPrefRoutingDir {
public:
                            oaPrefRoutingDir(oaPrefRoutingDirEnum valueIn);
                            oaPrefRoutingDir(const oaString &name);
                            ~oaPrefRoutingDir();

    const oaString          &getName() const;

                            operator                oaPrefRoutingDirEnum() const;

private:
    oaPrefRoutingDirEnum    value;

    static const oaString   names[];
};



// *****************************************************************************
// oaMaterialEnum
// *****************************************************************************
#define oavNumMaterialTypes         14

enum oaMaterialEnum {
    oacOtherMaterial            = 0,
    oacNWellMaterial            = 1,
    oacPWellMaterial            = 2,
    oacNDiffMaterial            = 3,
    oacPDiffMaterial            = 4,
    oacNImplantMaterial         = 5,
    oacPImplantMaterial         = 6,
    oacPolyMaterial             = 7,
    oacCutMaterial              = 8,
    oacMetalMaterial            = 9,
    oacContactlessMetalMaterial = 10,
    oacDiffMaterial             = 11,
    oacRecognitionMaterial      = 12,
    oacPassivationCutMaterial   = 13
};



// *****************************************************************************
// oaMaterial
// *****************************************************************************
class OA_TECH_DLL_API oaMaterial {
public:
                            oaMaterial(oaMaterialEnum valueIn);
                            oaMaterial(const oaString &name);
                            ~oaMaterial();

    const oaString          &getName() const;

                            operator                oaMaterialEnum() const;

private:
    static const oaString   *initNames();

    oaMaterialEnum          value;

    static const oaString   names[];
};



// *****************************************************************************
// oaPhysicalLayer
// *****************************************************************************
#define oacUnsetMaskNumber 0xffffffffu

class OA_TECH_DLL_API oaPhysicalLayer : public oaLayer {
public:
    static oaPhysicalLayer          *create(oaTech          *tech,
                                            const oaString  &name,
                                            oaLayerNum      number,
                                            oaMaterial      material = oacOtherMaterial,
                                            oaUInt4         maskNumber = oacUnsetMaskNumber);

    static oaPhysicalLayer          *find(const oaTech      *tech,
                                          const oaString    &name);
    static oaPhysicalLayer          *find(const oaTech  *tech,
                                          oaLayerNum    number);
    static oaPhysicalLayer          *find(const oaTech      *tech,
                                          const oaString    &name,
                                          oaBoolean         local);
    static oaPhysicalLayer          *find(const oaTech  *tech,
                                          oaLayerNum    number,
                                          oaBoolean     local);

    oaMaterial                      getMaterial() const;
    oaPrefRoutingDir                getPrefRoutingDir() const;
    oaUInt4                         getMaskNumber() const;
    oaDist                          getManufacturingGrid() const;

#if !defined(OA_DEPRECATED)
    oaPhysicalLayer                 *getLayerAbove(oaMaterial material) const;
    oaPhysicalLayer                 *getLayerBelow(oaMaterial material) const;
#endif

    oaCollection<oaLayer, oaTech>   getLayerAbove(const oaTech  *tech,
                                                  oaMaterial    material,
                                                  oaBoolean     local = false) const;
    oaCollection<oaLayer, oaTech>   getLayerBelow(const oaTech  *tech,
                                                  oaMaterial    material,
                                                  oaBoolean     local = false) const;

    void                            getExcludedLayers(oaLayerNameArray &excludedLayerNames) const;
    oaBoolean                       hasExcludedLayers() const;

    void                            setMaterial(oaMaterial material);
    void                            setPrefRoutingDir(oaPrefRoutingDir dir);
    void                            setMaskNumber(oaUInt4 number);
    void                            setManufacturingGrid(oaDist grid);
    void                            resetManufacturingGrid();
    void                            setExcludedLayers(const oaLayerNameArray &excludedLayerNames);
    void                            unsetExcludedLayers();
};



// *****************************************************************************
// oaTech traits
// *****************************************************************************
template<>
class oaTraits<oaPhysicalLayer> {
public:
    typedef oaLayerModTypeEnum  modTypeType;
    typedef oaLayer             parentType;
    enum {dtIndex = oacLayerDataType};
    enum {dataTypeEnumVal = oacLayerDataType};
    enum {dbType = oacTechDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPhysicalLayerType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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