oaWaferDBTypes.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaWaferDBTypes.h
//
// This file contains type definitions and declarations for this package.
//
// *****************************************************************************
// 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(oaWaferDBTypes_P)
#define oaWaferDBTypes_P



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



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



// *****************************************************************************
// Windows DLL export macros
// *****************************************************************************
#if defined(OA_WINDOWS) && defined(OA_WAFER_DLL_EXPORTS)
#define OA_WAFER_DLL_API __declspec(dllexport)
#define OA_WAFER_DLL_PVT __declspec(dllexport)
#define OA_WAFER_DLL_EXTERN
#elif defined(OA_WINDOWS) && !defined(OA_STATIC)
#define OA_WAFER_DLL_API __declspec(dllimport)
#define OA_WAFER_DLL_PVT __declspec(dllimport)
#define OA_WAFER_DLL_EXTERN extern
#else
#define OA_WAFER_DLL_API
#define OA_WAFER_DLL_PVT
#endif



// *****************************************************************************
// oaWaferDataTypeEnum    
//
// The first several entries are for the database itself and for data types with
// a variable number of tables. These entries should not be included in the
// number of data types.  The entries between 0 and oavBaseNumDataTypes are
// common to all databases and must match oaBaseDataTypeEnum. Note that the 
// dataIDs array for dataTbls--oaWaferData::waferDataTblIDs--should match this
// array.
// *****************************************************************************
#define oavNumWaferDataTypes        25
#define oavNumNewWaferDataTypes     2

enum oaWaferDataTypeEnum {
    oacWaferWaferDataType                   = UINT_MAX,
    oacAppObjectWaferDataType               = UINT_MAX - 1,
    oacPropWaferDataType                    = 0,
    oacGroupWaferDataType                   = 1,
    oacGroupMemWaferDataType                = 2,
    oacAvatarWaferDataType                  = 3,
    oacValueWaferDataType                   = 4,
    oacConstraintParamDefWaferDataType      = 5,
    oacConstraintParamWaferDataType         = 6,
    oacConstraintDefWaferDataType           = 7,
    oacConstraintWaferDataType              = 8,
    oacConstraintGroupWaferDataType         = 9,
    oacConstraintGroupMemWaferDataType      = 10,
    oacConstraintGroupHeaderWaferDataType   = 11,

    oacWaferDescWaferDataType               = 12,
    oacFrameWaferDataType                   = 13,
    oacReticleWaferDataType                 = 14,
    oacReticleRefWaferDataType              = 15,
    oacStepperMapWaferDataType              = 16,
    oacImageWaferDataType                   = 17,
    oacFrameInstWaferDataType               = 18,
    oacDesignInstWaferDataType              = 19,
    oacWaferFeatureWaferDataType            = 20,
    oacFeatureWaferDataType                 = 21,
    oacFeaturePolicyWaferDataType           = 22,
    oacGroupDefWaferDataType                = 23,
    oacConstraintGroupDefWaferDataType      = 24
};



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

    const oaString          &getName() const;

                            operator                oaWaferDataTypeEnum() const;

private:
    static const oaString   *initNames();
    static const oaString   *initVarNames();

    oaWaferDataTypeEnum     value;

    static const oaString   names[];
    static const oaString   varNames[];
};



// *****************************************************************************
// Forward Private Class Declarations
// *****************************************************************************
class oaWaferHashTbl;
class oaWaferStaticVarMemory;



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaWafer;
class oaWaferLibObserver;
class oaWaferDesc;
class oaWaferFeature;
class oaFrame;
class oaReticle;
class oaReticleRef;
class oaStepperMap;
class oaImage;
class oaFrameInst;
class oaDesignInst;



// *****************************************************************************
// Initialization Function Declaration
// *****************************************************************************
OA_WAFER_DLL_API extern void
oaWaferInit(oaUInt4 apiMajorRev = oacAPIMajorRevNumber,
            oaUInt4 apiMinorRev = oacAPIMinorRevNumber);

OA_WAFER_DLL_API extern void
oaWaferInit(oaUInt4 apiMajorRev,
            oaUInt4 apiMinorRev,
            oaUInt4 dataModelRev);



END_OA_NAMESPACE



#endif

Return to top of page

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