oaDesignDBTypes.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDesignDBTypes.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 2002-2006 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDesignDBTypes_P)
#define oaDesignDBTypes_P



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



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



// *****************************************************************************
// Windows DLL export macros
// *****************************************************************************
#if defined(OA_WINDOWS) && defined(OA_DESIGN_DLL_EXPORTS)
#define OA_DESIGN_DLL_API __declspec(dllexport)
#define OA_DESIGN_DLL_PVT __declspec(dllexport)
#define OA_DESIGN_DLL_EXTERN
#elif defined(OA_WINDOWS) && !defined(OA_STATIC)
#define OA_DESIGN_DLL_API __declspec(dllimport)
#define OA_DESIGN_DLL_PVT __declspec(dllimport)
#define OA_DESIGN_DLL_EXTERN extern
#else
#define OA_DESIGN_DLL_API
#define OA_DESIGN_DLL_PVT
#endif



// *****************************************************************************
// oaDesignDataTypeEnum    
//
// 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.  The entries
// between oacNetDataType and oaOccurrenceDataType correspond to the entries
// between oacOccNetDataType and oacOccOccurrenceDataType; the order in both
// ranges must match. Note that the dataID array for dataTbls -- 
// oaDesignData::designDataTblIDs -- should match this array.
// *****************************************************************************
#define oavNumDesignDataTypes           81
#define oavNumNewDesignDataTypes        8

enum oaDesignDataTypeEnum {
    oacDesignDataType                   = UINT_MAX,
    oacAppObjectDataType                = UINT_MAX - 1,

    oacOccNetDataType                   = UINT_MAX - 2,
    oacOccBusNetDefDataType             = UINT_MAX - 3,
    oacOccTermDataType                  = UINT_MAX - 4,
    oacOccBusTermDefDataType            = UINT_MAX - 5,
    oacOccInstHeaderDataType            = UINT_MAX - 6,
    oacOccModuleInstHeaderDataType      = UINT_MAX - 7,
    oacOccInstDataType                  = UINT_MAX - 8,
    oacOccVectorInstDefDataType         = UINT_MAX - 9,
    oacOccInstTermDataType              = UINT_MAX - 10,
    oacOccConnectDefDataType            = UINT_MAX - 11,
    oacOccAssignmentDataType            = UINT_MAX - 12,
    oacOccOccurrenceDataType            = UINT_MAX - 13,

    oacPropDataType                     = 0,
    oacGroupDataType                    = 1,
    oacGroupMemDataType                 = 2,
    oacAvatarDataType                   = 3,
    oacValueDataType                    = 4,
    oacConstraintParamDefDataType       = 5,
    oacConstraintParamDataType          = 6,
    oacConstraintDefDataType            = 7,
    oacConstraintDataType               = 8,
    oacConstraintGroupDataType          = 9,
    oacConstraintGroupMemDataType       = 10,
    oacConstraintGroupHeaderDataType    = 11,

    oacNetDataType                      = 12,
    oacBusNetDefDataType                = 13,
    oacTermDataType                     = 14,
    oacBusTermDefDataType               = 15,
    oacInstHeaderDataType               = 16,
    oacModuleInstHeaderDataType         = 17,
    oacInstDataType                     = 18,
    oacVectorInstDefDataType            = 19,
    oacInstTermDataType                 = 20,
    oacConnectDefDataType               = 21,
    oacAssignmentDataType               = 22,
    oacOccurrenceDataType               = 23,
    oacLPPHeaderDataType                = 24,
    oacLayerHeaderDataType              = 25,
    oacShapeDataType                    = 26,
    oacRouteDataType                    = 27,
    oacPinDataType                      = 28,
    oacTDLinkDataType                   = 29,
    oacDesignParamDataType              = 30,
    oacMarkerDataType                   = 31,
    oacTrackPatternDataType             = 32,
    oacMarkerMemDataType                = 33,
    oacRowHeaderDataType                = 34,
    oacRowDataType                      = 35,
    oacClusterDataType                  = 36,
    oacBoundaryDataType                 = 37,
    oacSteinerDataType                  = 38,
    oacScanChainDataType                = 39,
    oacScanChainInstDataType            = 40,
    oacScanChainSetDataType             = 41,
    oacViaHeaderDataType                = 42,
    oacGCellPatternDataType             = 43,
    oacCMapDataType                     = 44,
    oacCMapLPDataType                   = 45,
    oacGCellDataType                    = 46,
    oacDesignViaParamDataType           = 47,
    oacAnalysisPointDataType            = 48,
    oacAnalysisOpPointDataType          = 49,
    oacOpPointHeaderDataType            = 50,
    oacBlockageDataType                 = 51,
    oacGuideDataType                    = 52,
    oacParasiticNetworkDataType         = 53,
    oacNodeDataType                     = 54,
    oacDeviceDataType                   = 55,
    oacSubNetworkDataType               = 56,
    oacSubNetworkMemDataType            = 57,
    oacReducedModelDataType             = 58,
    oacElmoreDataType                   = 59,
    oacPoleResidueDataType              = 60,
    oacBlockDataType                    = 61,
    oacModuleDataType                   = 62,
    oacOccHeaderDataType                = 63,
    oacViaDataType                      = 64,
    oacSegStyleDataType                 = 65,
    oacOccShapeDataType                 = 66,
    oacHierPathDataType                 = 67,
    oacAnalysisPtSetDataType            = 68,
    oacDetailedNetworkDataType          = 69,
    oacGlobalDataType                   = 70,
    oacGlobalMemDataType                = 71,
    oacOccGlobalMemDataType             = 72,
    oacFeatureDataType                  = 73,
    oacFeaturePolicyDataType            = 74,
    oacFigGroupDataType                 = 75,
    oacFigGroupMemDataType              = 76,
    oacGroupDefDataType                 = 77,
    oacConstraintGroupDefDataType       = 78,

    oacDesignViaVariantDataType         = 79,
    oacDesignViaVariantHeaderDataType   = 80
};



// *****************************************************************************
// oaDesignDataType
// *****************************************************************************
class OA_DESIGN_DLL_API oaDesignDataType {
public:
                            oaDesignDataType(oaDesignDataTypeEnum valueIn);
                            oaDesignDataType(const oaString &name);
                            ~oaDesignDataType();

    const oaString          &getName() const;

                            operator                oaDesignDataTypeEnum() const;

private:
    static const oaString   *initNames();

    oaDesignDataTypeEnum    value;

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



// *****************************************************************************
// Forward Private Class Declarations
// *****************************************************************************
class oaAnalysisOpPointTbl;
class oaAnalysisPointTbl;
class oaAnalysisPtMapTbl;
class oaAnalysisPtSetTbl;
class oaArcTbl;
class oaAssignmentTbl;
class oaAttrDisplayTbl;
class oaBlockTbl;
class oaBlockageQueryPvt;
class oaBlockageTbl;
class oaBoundaryQueryPvt;
class oaBoundaryTbl;
class oaBusNetDefTbl;
class oaBusTermDefTbl;
class oaCMapLPTbl;
class oaCMapTbl;
class oaClusterTbl;
class oaConnectDefTbl;
class oaCoupledNetTbl;
class oaCouplingCapTbl;
class oaDesignData;
class oaDesignDataIter;
class oaDesignDataTbl;
class oaDesignHashTbl;
class oaDesignHeaderTbl;
class oaDesignViaVariantTbl;
class oaDesignViaVariantHeaderTbl;
class oaDesignLibObserver;
class oaDesignStaticVarMemory;
class oaDesignTechObserver;
class oaDesignUndoObserverPvt;
class oaDetailedData;
class oaDetailedNetworkTbl;
class oaDeviceIdHashTbl;
class oaDeviceNameHashTbl;
class oaDeviceTbl;
class oaDiodeTbl;
class oaDonutTbl;
class oaEllipseTbl;
class oaElmoreTbl;
class oaEvalTextTbl;
class oaFigGroupTbl;
class oaFigGroupMemTbl;
class oaFigGroupQueryPvt;
class oaFigTbl;
class oaGCellPatternTbl;
class oaGCellTbl;
class oaGroundedNodeTbl;
class oaGuideQueryPvt;
class oaGuideTbl;
class oaHierPathTbl;
class oaInductorTbl;
class oaInstAttrDisplayTbl;
class oaInstHeaderTbl;
class oaInstPropDisplayTbl;
class oaInstQueryPvt;
class oaInstTbl;
class oaInstTermTbl;
class oaInstTermValidator;
class oaLPPHeaderHashTbl;
class oaLayerHeaderTbl;
class oaLayerHeaderHashTbl;
class oaLayerRangeBlockageQueryPvt;
class oaLPPHeaderTbl;
class oaLineTbl;
class oaMarkerMemTbl;
class oaMarkerQueryPvt;
class oaMarkerTbl;
class oaModuleInstHeaderTbl;
class oaModuleTbl;
class oaMutualInductorTbl;
class oaNetTbl;
class oaNodeConnTbl;
class oaNodeNameHashTbl;
class oaNodeSubTbl;
class oaNodeTbl;
class oaOccDataTbl;
class oaOccInstTbl;
class oaOccHeaderList;
class oaOccHeaderTbl;
class oaOccOccurrenceTbl;
class oaOccShapeTbl;
class oaOccTraverserPvt;
class oaOccurrenceTbl;
class oaOpPointHeaderTbl;
class oaPagedDataTbl;
class oaPagedDatabase;
class oaPagedFreeListTbl;
class oaPagedTbl;
class oaParamArrayData;
class oaParamData;
class oaDesignParamTbl;
class oaParasiticNetworkTbl;
class oaPathSegTbl;
class oaPathTbl;
class oaPcellDef;
class oaPinTbl;
class oaPlacementBlockageQueryPvt;
class oaPoleResidueTbl;
class oaPolygonTbl;
class oaPropDisplayTbl;
class oaRectTbl;
class oaReducedModelTbl;
class oaRefTbl;
class oaRefHeaderList;
class oaRefHeaderTbl;
class oaRefHeaderTbl;
class oaRegionQueryPvt;
class oaResistorTbl;
class oaRouteTbl;
class oaRowHeaderTbl;
class oaRowQueryPvt;
class oaRowTbl;
class oaScanChainInstTbl;
class oaScanChainSetTbl;
class oaScanChainTbl;
class oaSegStyleTbl;
class oaSeriesRLTbl;
class oaShapeQueryPvt;
class oaShapeTbl;
class oaStdDeviceData;
class oaSteinerQueryPvt;
class oaSteinerTbl;
class oaSubMasterData;
class oaSubMasterData;
class oaSubNetworkMemTbl;
class oaSubNetworkNameHashTbl;
class oaSubNetworkTbl;
class oaSuperMasterData;
class oaSuperMasterData;
class oaTDLinkTbl;
class oaTermMap;
class oaTermTbl;
class oaTextDisplayTbl;
class oaTextOverrideTbl;
class oaTextTbl;
class oaTrackPatternTbl;
class oaVariantHashTbl;
class oaVectorInstDefTbl;
class oaViaHeaderHashTbl;
class oaViaHeaderTbl;
class oaViaMasterData;
class oaDesignViaParamTbl;
class oaViaQueryPvt;
class oaViaTbl;
class oaDesignViaVariantHeaderTbl;

template <class T>
class oaUnboundListTbl;



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaAnalysisOpPoint;
class oaAnalysisPoint;
class oaAnalysisPointArray;
class oaAntennaArea;
class oaAntennaAreaArray;
class oaAntennaData;
class oaAreaBoundary;
class oaArrayInst;
class oaAssignment;
class oaAssignmentDef;
class oaBitInst;
class oaBitNet;
class oaBitTerm;
class oaBlock;
class oaBlockage;
class oaBlockage;
class oaBoundary;
class oaBundleNet;
class oaBundleTerm;
class oaBundleTerm;
class oaBusNet;
class oaBusNetBit;
class oaBusNetDef;
class oaBusTerm;
class oaBusTermBit;
class oaBusTermDef;
class oaCMap;
class oaDesign;
class oaDesignType;
class oaCluster;
class oaClusterBoundary;
class oaConnectDef;
class oaCouplingCap;
class oaDevice;
class oaElmore;
class oaEvalTextLink;
class oaFig;
class oaFigGroup;
class oaFigGroupMem;
class oaConnFig;
class oaPinFig;
class oaGCellPattern;
class oaGroundedNode;
class oaGuide;
class oaHierPath;
class oaInductor;
class oaInst;
class oaInstHeader;
class oaInstTerm;
class oaLPPHeader;
class oaLayerHeader;
class oaLine;
class oaLumpedElmore;
class oaMarker;
class oaModAssignment;
class oaModBitInst;
class oaModBitNet;
class oaModBitTerm;
class oaModBundleNet;
class oaModBundleTerm;
class oaModBusNet;
class oaModBusNetBit;
class oaModBusNetDef;
class oaModBusTerm;
class oaModBusTermBit;
class oaModBusTermDef;
class oaModDesignInst;
class oaModConnectDef;
class oaModConnectDef;
class oaModInst;
class oaModInstHeader;
class oaModInstTerm;
class oaModModuleInst;
class oaModModuleInstHeader;
class oaModNet;
class oaModNetConnectDef;
class oaModNetTermArray;
class oaModNetTermNameArray;
class oaModNetTermPosArray;
class oaModScalarInst;
class oaModModuleScalarInst;
class oaModScalarNet;
class oaModScalarTerm;
class oaModTerm;
class oaModTermConnectDef;
class oaModVectorInstBit;
class oaModVectorInstDef;
class oaModModuleVectorInst;
class oaModModuleVectorInstBit;
class oaModule;
class oaMutualInductor;
class oaNet;
class oaNetConnectDef;
class oaNetTermArray;
class oaNetTermNameArray;
class oaNetTermPosArray;
class oaNode;
class oaOccArrayInst;
class oaOccAssignment;
class oaOccBitInst;
class oaOccBitNet;
class oaOccBitTerm;
class oaOccBundleNet;
class oaOccBundleTerm;
class oaOccBusNet;
class oaOccBusNetBit;
class oaOccBusNetDef;
class oaOccBusTerm;
class oaOccBusTermBit;
class oaOccBusTermDef;
class oaOccDesignInst;
class oaOccConnectDef;
class oaOccConnectDef;
class oaOccInst;
class oaOccInstHeader;
class oaOccInstTerm;
class oaOccModuleInst;
class oaOccModuleInstHeader;
class oaOccModuleScalarInst;
class oaOccObject;
class oaOccNet;
class oaOccNetConnectDef;
class oaOccScalarNet;
class oaOccScalarTerm;
class oaOccTerm;
class oaOccTermConnectDef;
class oaOccTraverser;
class oaOccVectorInstBit;
class oaOccVectorInstDef;
class oaOccModuleVectorInst;
class oaOccModuleVectorInstBit;
class oaOccShape;
class oaOccurrence;
class oaOpPointHeader;
class oaParasiticNetwork;
class oaParasiticQuery;
class oaParasiticQueryPvt;
class oaPcellLink;
class oaPiElmore;
class oaPiPoleResidue;
class oaPin;
class oaPoleResidue;
class oaPoleResidue;
class oaPolygon;
class oaRef;
class oaRefHeader;
class oaRegionQueryPlug;
class oaRegionQueryPlugMgr;
class oaResistor;
class oaRoute;
class oaRow;
class oaRowHeader;
class oaScalarInst;
class oaScalarNet;
class oaScalarTerm;
class oaScanChain;
class oaScanChainInst;
class oaScanChainSet;
class oaScriptEngineLink;
class oaSeriesRL;
class oaShape;
class oaStdDevice;
class oaSteiner;
class oaSubNetwork;
class oaTerm;
class oaTermConnectDef;
class oaTextDisplayCollection;
class oaTrackPattern;
class oaVectorInst;
class oaVectorInstBit;
class oaVectorInstDef;
class oaVia;
class oaViaHeader;
class oaDesignViaVariantHeader;



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

OA_DESIGN_DLL_API extern void
oaDesignInit(oaUInt4    apiMajorRev,
             oaUInt4    apiMinorRev,
             oaUInt4    dataModelRev);


END_OA_NAMESPACE



// *****************************************************************************
// Implementation Include
// *****************************************************************************
#include "oaDesignDBTypes.inl"



#endif

Return to top of page

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