oaDesignInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDesignInst.h
//
// This file contains the definition for the oaDesignInst class and its public
// supporting classes. 
//
// *****************************************************************************
// 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 2004-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDesignInst_P)
#define oaDesignInst_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaTransform.h"
#include "oaTechDBTypes.h"
#include "oaFrame.h"
#include "oaReticle.h"



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



// *****************************************************************************
// oaReticleUsageEnum
// *****************************************************************************
#define oavNumReticleUsageEnums    9

enum oaReticleUsageEnum {
    oacDieReticleUsage              = 0,
    oacAlignmentReticleUsage        = 1,
    oacBarCodeReticleUsage          = 2,
    oacIdentificationReticleUsage   = 3,
    oacDieSealReticleUsage          = 4,
    oacDieNumberReticleUsage        = 5,
    oacLogoReticleUsage             = 6,
    oacElectricalReticleUsage       = 7,
    oacOpticalReticleUsage          = 8
};



// *****************************************************************************
// oaReticleUsage
// *****************************************************************************
class OA_WAFER_DLL_API oaReticleUsage {
public:
                            oaReticleUsage(oaReticleUsageEnum valueIn);
                            oaReticleUsage(const oaString &name);

    const oaString          &getName() const;

                            operator                oaReticleUsageEnum() const;

private:
    static const oaString   *initNames();

    oaReticleUsageEnum      value;

    static const oaString   names[];
};



// *****************************************************************************
// oaLayerMap
// *****************************************************************************
class OA_WAFER_DLL_API oaLayerMap {
public:
                            oaLayerMap();
                            oaLayerMap(oaLayerNum   waferLayer,
                                       oaLayerNum   designLayer);
                            oaLayerMap(const oaLayerMap &layerMap);

    oaLayerNum              waferLayer() const;
    oaLayerNum              designLayer() const;

    oaLayerNum              &waferLayer();
    oaLayerNum              &designLayer();

    oaLayerMap              &operator=(const oaLayerMap &layerMap);

    oaBoolean               operator==(const oaLayerMap &layerMap);
    oaBoolean               operator!=(const oaLayerMap &layerMap);
    oaBoolean               operator==(const oaLayerMap &layerMap) const;
    oaBoolean               operator!=(const oaLayerMap &layerMap) const;

private:
    oaLayerNum              waferLayerNum;
    oaLayerNum              designLayerNum;
};



// *****************************************************************************
// oaLayerMapArray
// *****************************************************************************
class OA_WAFER_DLL_API oaLayerMapArray : public oaArray<oaLayerMap> {
public:
                            oaLayerMapArray(oaUInt4 size = 0);
                            oaLayerMapArray(const oaLayerMapArray &layers);
};



// *****************************************************************************
// oaDesignInst
// *****************************************************************************
class OA_WAFER_DLL_API oaDesignInst : public oaWaferObject {
public:
    static oaDesignInst     *create(oaReticle           *reticle,
                                    const oaString      &name,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    oaFloat             magnification,
                                    const oaTransform   &xform,
                                    oaBoolean           isPrintable,
                                    oaReticleUsage      reticleUsage);

    static oaDesignInst     *create(oaFrame             *frame,
                                    const oaString      &name,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    oaFloat             magnification,
                                    const oaTransform   &xform,
                                    oaBoolean           isPrintable,
                                    oaReticleUsage      reticleUsage);

    void                    destroy();

    static oaDesignInst     *find(const oaWafer     *wafer,
                                  const oaString    &name);

    void                    getName(oaString &name) const;
    void                    getLibName(oaScalarName &name) const;
    void                    getLibName(const oaNameSpace    &nameSpace,
                                       oaString             &name) const;
    void                    getCellName(oaScalarName &name) const;
    void                    getCellName(const oaNameSpace   &nameSpace,
                                        oaString            &name) const;
    void                    getViewName(oaScalarName &name) const;
    void                    getViewName(const oaNameSpace   &nameSpace,
                                        oaString            &name) const;
    oaFloat                 getMag() const;
    void                    getOrigin(oaPoint &origin) const;
    oaOrient                getOrient() const;
    void                    getTransform(oaTransform &xform) const;
    oaWaferObject           *getOwner() const;
    void                    getLayerMapping(oaLayerMapArray &layers) const;
    oaReticleUsage          getReticleUsage() const;

    oaBoolean               isPrintable() const;
    oaBoolean               hasLayerMapping() const;

    void                    setName(const oaString &name);
    void                    setOrigin(const oaPoint &origin);
    void                    setOrient(oaOrient orient);
    void                    setTransform(const oaTransform &xform);
    void                    setPrintable(oaBoolean value);
    void                    setMag(oaFloat mag);
    void                    setLayerMapping(const oaLayerMapArray &layers);
    void                    setReticleUsage(oaReticleUsage reticalUsage);

    enum {dtIndex = oacDesignInstWaferDataType};
};



// *****************************************************************************
// Wafer traits.
// *****************************************************************************
template<>
class oaTraits<oaDesignInst> {
public:
    typedef oaWaferObject           parentType;
    typedef oaDesignInstModTypeEnum modTypeType;
    enum {dbType = oacWaferDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacDesignInstWaferDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacDesignInstType};
    enum {dataTypeEnumVal = oacDesignInstWaferDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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