oaWafer.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaWafer.h
//
// This file contains the definition for the oaWafer class and its public
// supporting classes. The oaWafer class implements a wafer database which
// is the main object for storing the description of a wafer and the reticles
// frames, and images to associate with the wafer.
//
// *****************************************************************************
// 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(oaWafer_P)
#define oaWafer_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaName.h"
#include "oaArray.h"
#include "oaAppObjectDef.h"
#include "oaCollection.h"
#include "oaWaferObject.h"



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



// *****************************************************************************
// oaWaferUnitsEnum
// *****************************************************************************
#define oavNumWaferUnits    4

enum oaWaferUnitsEnum {
    oacMicronWaferUnits     = 0,
    oacMilWaferUnits        = 1,
    oacMillimeterWaferUnits = 2,
    oacNanometerWaferUnits  = 3
};



// *****************************************************************************
// oaWaferUnitsType
// *****************************************************************************
class OA_WAFER_DLL_API oaWaferUnitsType {
public:
                            oaWaferUnitsType(oaWaferUnitsEnum valueIn);
                            oaWaferUnitsType(const oaString &name);
                            ~oaWaferUnitsType();

    const oaString          &getName() const;

                            operator                oaWaferUnitsEnum() const;

private:
    static const oaString   *initNames();

    oaWaferUnitsEnum        value;

    static const oaString   names[];
};



// *****************************************************************************
// oaWafer
// *****************************************************************************
class OA_WAFER_DLL_API oaWafer : public oaWaferObject {
public:
    static oaWafer                          *open(const oaScalarName    &libName,
                                                  const oaScalarName    &cellName,
                                                  const oaScalarName    &viewName,
                                                  oaChar                mode = 'r');

    static oaWafer                          *find(const oaScalarName    &libName,
                                                  const oaScalarName    &cellName,
                                                  const oaScalarName    &viewName);

    static oaBoolean                        exists(const oaScalarName   &libName,
                                                   const oaScalarName   &cellName,
                                                   const oaScalarName   &viewName);

    static void                             destroy(const oaScalarName  &libName,
                                                    const oaScalarName  &cellName,
                                                    const oaScalarName  &viewName);

    void                                    close();
    void                                    purge();
    void                                    save();
    void                                    saveAs(const oaScalarName   &libName,
                                                   const oaScalarName   &cellName,
                                                   const oaScalarName   &viewName);
    void                                    reopen(oaChar mode);
    void                                    revert();

    void                                    getLibName(oaScalarName &libName) const;
    void                                    getCellName(oaScalarName &cellName) const;
    void                                    getViewName(oaScalarName &viewName) const;

    void                                    getLibName(const oaNameSpace    &ns,
                                                       oaString             &libStr) const;
    void                                    getCellName(const oaNameSpace   &ns,
                                                        oaString            &cellStr) const;
    void                                    getViewName(const oaNameSpace   &ns,
                                                        oaString            &viewStr) const;

    oaTimeStamp                             getTimeStamp(oaWaferDataType type) const;
    oaTimeStamp                             getTimeStamp(oaAppObjectDef *def) const;
    oaChar                                  getMode() const;
    oaUInt4                                 getRefCount() const;
    oaTime                                  getCreateTime() const;
    oaTime                                  getReadInTime() const;
    oaTime                                  getLastSavedTime() const;
    oaUInt4                                 getDBUPerWU() const;
    oaWaferUnitsType                        getWaferUnits() const;
    oaWaferDesc                             *getWaferDesc() const;

    void                                    setDBUPerWU(oaUInt4 value);
    void                                    setWaferUnits(oaWaferUnitsType value);

    oaBoolean                               isModified() const;

    oaBoolean                               isUndoEnabled() const;

    void                                    enableUndo(oaBoolean value = true);
    void                                    undo();
    void                                    redo();
    void                                    setCp();

    oaUInt8                                 calcVMSize() const;

    static oaUInt4                          getRevNumber();

    void                                    getFeatures(oaUInt4         &dataModelRev,
                                                        oaFeatureArray  &features);

    oaCollection<oaReticle, oaWafer>        getReticles() const;
    oaCollection<oaReticleRef, oaWafer>     getReticleRefs() const;
    oaCollection<oaFrame, oaWafer>          getFrames() const;
    oaCollection<oaImage, oaWafer>          getImages() const;

    static oaCollection<oaWafer, oaWafer>   getOpenWafers();

    enum {dtIndex = oacWaferWaferDataType};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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