oaType.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaType.h
//
// This file contains the definition for the oaType class. It implements a class
// that represents the type of all database objects.
//
// *****************************************************************************
// 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 2003-2007 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaType_P)
#define oaType_P



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



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaString;



// *****************************************************************************
// oaTypeEnum   Note! Increase oavNumObjectTypes when adding a new type.
// *****************************************************************************
#define oavNumObjectTypes           287

enum oaTypeEnum {
    oacUnknownType                  = 0,
    oacSessionType                  = 1,
    oacLibType                      = 2,
    oacTechType                     = 3,
    oacDesignType                   = 4,
    oacWaferType                    = 5,

    oacBlockType                    = 6,
    oacModuleType                   = 7,
    oacOccurrenceType               = 8,

    oacLPPHeaderType                = 9,
    oacLayerHeaderType              = 10,
    oacArcType                      = 11,
    oacDonutType                    = 12,
    oacDotType                      = 13,
    oacEllipseType                  = 14,
    oacLineType                     = 15,
    oacPathType                     = 16,
    oacPathSegType                  = 17,
    oacPolygonType                  = 18,
    oacRectType                     = 19,
    oacTextType                     = 20,
    oacEvalTextType                 = 21,
    oacPropDisplayType              = 22,
    oacAttrDisplayType              = 23,
    oacTextOverrideType             = 24,
    oacInstPropDisplayType          = 25,
    oacInstAttrDisplayType          = 26,
    oacRouteType                    = 27,
    oacMarkerType                   = 28,
    oacTrackPatternType             = 29,
    oacRowType                      = 30,
    oacRowHeaderType                = 31,
    oacPinType                      = 32,
    oacClusterType                  = 33,
    oacAreaBoundaryType             = 34,
    oacPRBoundaryType               = 35,
    oacSnapBoundaryType             = 36,
    oacClusterBoundaryType          = 37,
    oacAreaBlockageType             = 38,
    oacAreaHaloType                 = 39,
    oacLayerBlockageType            = 40,
    oacLayerHaloType                = 41,
    oacSteinerType                  = 42,
    oacStdViaType                   = 43,
    oacCustomViaType                = 44,
    oacStdViaHeaderType             = 45,
    oacCustomViaHeaderType          = 46,
    oacGCellPatternType             = 47,
    oacCMapType                     = 48,
    oacArrayInstType                = 49,

    oacScalarInstType               = 50,
    oacVectorInstType               = 51,
    oacVectorInstBitType            = 52,
    oacVectorInstDefType            = 53,
    oacBundleNetType                = 54,
    oacBusNetType                   = 55,
    oacBusNetBitType                = 56,
    oacScalarNetType                = 57,
    oacBusNetDefType                = 58,
    oacBundleTermType               = 59,
    oacBusTermType                  = 60,
    oacBusTermBitType               = 61,
    oacScalarTermType               = 62,
    oacBusTermDefType               = 63,
    oacInstTermType                 = 64,
    oacNetConnectDefType            = 65,
    oacTermConnectDefType           = 66,
    oacAssignValueType              = 67,
    oacAssignAssignmentType         = 68,
    oacScanChainType                = 69,
    oacScanChainInstType            = 70,
    oacScanChainSetType             = 71,
    oacInstHeaderType               = 72,

    oacOccScalarInstType            = 73,
    oacOccVectorInstType            = 74,
    oacOccVectorInstBitType         = 75,
    oacOccVectorInstDefType         = 76,
    oacOccBundleNetType             = 77,
    oacOccBusNetType                = 78,
    oacOccBusNetBitType             = 79,
    oacOccScalarNetType             = 80,
    oacOccBusNetDefType             = 81,
    oacOccBundleTermType            = 82,
    oacOccBusTermType               = 83,
    oacOccBusTermBitType            = 84,
    oacOccScalarTermType            = 85,
    oacOccBusTermDefType            = 86,
    oacOccInstTermType              = 87,
    oacOccNetConnectDefType         = 88,
    oacOccTermConnectDefType        = 89,
    oacOccAssignValueType           = 90,
    oacOccAssignAssignmentType      = 91,
    oacObsoleteType92               = 92,
    oacObsoleteType93               = 93,
    oacObsoleteType94               = 94,
    oacOccInstHeaderType            = 95,

    oacModScalarInstType            = 96,
    oacModVectorInstType            = 97,
    oacModVectorInstBitType         = 98,
    oacModVectorInstDefType         = 99,
    oacModBundleNetType             = 100,
    oacModBusNetType                = 101,
    oacModBusNetBitType             = 102,
    oacModScalarNetType             = 103,
    oacModBusNetDefType             = 104,
    oacModBundleTermType            = 105,
    oacModBusTermType               = 106,
    oacModBusTermBitType            = 107,
    oacModScalarTermType            = 108,
    oacModBusTermDefType            = 109,
    oacModInstTermType              = 110,
    oacModNetConnectDefType         = 111,
    oacModTermConnectDefType        = 112,
    oacModAssignValueType           = 113,
    oacModAssignAssignmentType      = 114,
    oacObsoleteType115              = 115,
    oacObsoleteType116              = 116,
    oacObsoleteType117              = 117,
    oacModInstHeaderType            = 118,

    oacModModuleScalarInstType      = 119,
    oacModModuleVectorInstType      = 120,
    oacModModuleVectorInstBitType   = 121,

    oacOccArrayInstType             = 122,
    oacOccModuleScalarInstType      = 123,
    oacOccModuleVectorInstType      = 124,
    oacOccModuleVectorInstBitType   = 125,

    oacOccModuleInstHeaderType      = 126,
    oacModModuleInstHeaderType      = 127,

    oacAnalysisPointType            = 128,
    oacAnalysisOpPointType          = 129,
    oacOpPointHeaderType            = 130,
    oacReducedDriverType            = 131,
    oacParasiticNetworkType         = 132,
    oacSubNetworkType               = 133,
    oacSubNetworkMemType            = 134,
    oacResistorType                 = 135,
    oacCouplingCapType              = 136,
    oacInductorType                 = 137,
    oacDiodeType                    = 138,
    oacSeriesRLType                 = 139,
    oacMutualInductorType           = 140,
    oacExternalDeviceType           = 141,
    oacNodeType                     = 142,
    oacGroundedNodeType             = 143,
    oacGuideType                    = 144,
    oacLumpedElmoreType             = 145,
    oacPiElmoreType                 = 146,
    oacPiPoleResidueType            = 147,
    oacElmoreType                   = 148,
    oacPoleResidueType              = 149,

    oacOccArcType                   = 150,
    oacOccDonutType                 = 151,
    oacOccDotType                   = 152,
    oacOccEllipseType               = 153,
    oacOccLineType                  = 154,
    oacOccPathType                  = 155,
    oacOccPathSegType               = 156,
    oacOccPolygonType               = 157,
    oacOccRectType                  = 158,
    oacOccTextType                  = 159,
    oacOccEvalTextType              = 160,
    oacOccPropDisplayType           = 161,
    oacOccAttrDisplayType           = 162,
    oacOccTextOverrideType          = 163,
    oacOccInstPropDisplayType       = 164,
    oacOccInstAttrDisplayType       = 165,

    oacIntPropType                  = 166,
    oacIntRangePropType             = 167,
    oacFloatPropType                = 168,
    oacFloatRangePropType           = 169,
    oacStringPropType               = 170,
    oacAppPropType                  = 171,
    oacDoublePropType               = 172,
    oacDoubleRangePropType          = 173,
    oacBooleanPropType              = 174,
    oacHierPropType                 = 175,
    oacTimePropType                 = 176,
    oacTimeRangePropType            = 177,
    oacEnumPropType                 = 178,

    oacGroupType                    = 179,
    oacGroupMemberType              = 180,

    oacPhysicalLayerType            = 181,
    oacDerivedLayerType             = 182,
    oacSizedLayerType               = 183,
    oacPurposeType                  = 184,
    oacScalarSiteDefType            = 185,
    oacArraySiteDefType             = 186,
    oacViaSpecType                  = 187,
    oacStdViaDefType                = 188,
    oacCustomViaDefType             = 189,
    oacOpPointType                  = 190,
    oacAnalysisLibType              = 191,

    oacAppObjectType                = 192,

    oacCellType                     = 193,
    oacViewType                     = 194,
    oacCellViewType                 = 195,
    oacDMFileType                   = 196,

    oacWaferDescType                = 197,
    oacFrameType                    = 198,
    oacReticleType                  = 199,
    oacReticleRefType               = 200,
    oacWaferFeatureType             = 201,
    oacStepperMapType               = 202,
    oacImageType                    = 203,
    oacFrameInstType                = 204,
    oacDesignInstType               = 205,

    oacViewTypeType                 = 206,

    oacConstraintParamDefType       = 207,
    oacConstraintParamType          = 208,

    oacSimpleConstraintDefType      = 209,
    oacLayerConstraintDefType       = 210,
    oacLayerPairConstraintDefType   = 211,

    oacSimpleConstraintType         = 212,
    oacLayerConstraintType          = 213,
    oacLayerPairConstraintType      = 214,

    oacConstraintGroupType          = 215,
    oacConstraintGroupMemType       = 216,
    oacConstraintGroupHeaderType    = 217,

    oacBooleanValueType             = 218,
    oacIntValueType                 = 219,
    oacFltValueType                 = 220,
    oacLayerArrayValueType          = 221,
    oacInt1DTblValueType            = 222,
    oacFlt1DTblValueType            = 223,
    oacInt2DTblValueType            = 224,
    oacFlt2DTblValueType            = 225,
    oacIntFltTblValueType           = 226,
    oacFltIntFltTblValueType        = 227,
    oacDualIntValueType             = 228,
    oacDualInt1DTblValueType        = 229,
    oacBoxArrayValueType            = 230,
    oacValueArrayValueType          = 231,
    oacViaDefArrayValueType         = 232,
    oacLayerValueType               = 233,
    oacAntennaRatioValueType        = 234,
    oacAntennaRatioArrayValueType   = 235,
    oacViaDef2DTblValueType         = 236,

    oacIntAppDefType                = 237,
    oacFloatAppDefType              = 238,
    oacStringAppDefType             = 239,
    oacIntraPointerAppDefType       = 240,
    oacInterPointerAppDefType       = 241,
    oacDataAppDefType               = 242,
    oacVarDataAppDefType            = 243,
    oacTimeAppDefType               = 244,
    oacDoubleAppDefType             = 245,
    oacVoidPointerAppDefType        = 246,
    oacBooleanAppDefType            = 247,
    oacAppObjectDefType             = 248,

    oacLibDefListType               = 249,
    oacLibDefType                   = 250,
    oacLibDefListRefType            = 251,

    oacLibDMDataType                = 252,
    oacCellDMDataType               = 253,
    oacViewDMDataType               = 254,
    oacCellViewDMDataType           = 255,

    oacFeatureType                  = 256,

    oacFigGroupType                 = 257,
    oacFigGroupMemType              = 258,

    oacTechHeaderType               = 259,
    oacTechLayerHeaderType          = 260,
    oacTechViaDefHeaderType         = 261,

    oacLayerArrayConstraintDefType  = 262,
    oacLayerArrayConstraintType     = 263,

    oacUInt8ValueType               = 264,
    oacIntDualIntArrayTblValueType  = 265,
    oacIntRangeValueType            = 266,
    oacUInt8RangeValueType          = 267,

    oacDerivedLayerParamDefType     = 268,
    oacDerivedLayerParamType        = 269,
    oacDerivedLayerDefType          = 270,

    oacPurposeValueType             = 271,

    oacConstraintGroupDefType       = 272,

    oacStdViaVariantType            = 273,
    oacCustomViaVariantType         = 274,

    oacTechViaVariantHeaderType     = 275,
    oacDesignViaVariantHeaderType   = 276,

    oacViaTopologyArrayValueType    = 277,
    oacViaTopology2DTblValueType    = 278,
    oacStringValueType              = 279,

    oacLayerRangeBlockageType       = 280,
    oacLayerRangeHaloType           = 281,
    oacIntRangeArrayValueType       = 282,
    oacIntRangeArray1DTblValueType  = 283,
    oacIntRangeArray2DTblValueType  = 284,

    oacFlatGroupDefType             = 285,
    oacHierGroupDefType             = 286
};



// *****************************************************************************
// oaAbstractTypeEnum 
// Note! Increase oavNumObjectAbstractTypes when adding a new abstract type.
// *****************************************************************************
#define oavAbstractTypeMask         0x80000000
#define oavNumObjectAbstractTypes   72

enum oaAbstractTypeEnum {
    oacDesignObjectType     = 0,
    oacDeviceType           = 1,
    oacReducedModelType     = 2,
    oacBlockObjectType      = 3,
    oacAssignmentType       = 4,
    oacConnectDefType       = 5,
    oacFigType              = 6,
    oacNetType              = 7,
    oacOccShapeType         = 8,
    oacRefHeaderType        = 9,
    oacTermType             = 10,
    oacStdDeviceType        = 11,
    oacBlockageType         = 12,
    oacBoundaryType         = 13,
    oacConnFigType          = 14,
    oacBitNetType           = 15,
    oacOccTextDisplayType   = 16,
    oacViaHeaderType        = 17,
    oacBitTermType          = 18,
    oacPinFigType           = 19,
    oacRefType              = 20,
    oacShapeType            = 21,
    oacTextDisplayType      = 22,
    oacInstType             = 23,
    oacBitInstType          = 24,
    oacViaType              = 25,
    oacModObjectType        = 26,
    oacModAssignmentType    = 27,
    oacModConnectDefType    = 28,
    oacModTermType          = 29,
    oacModInstType          = 30,
    oacModDesignInstType    = 31,
    oacModModuleInstType    = 32,
    oacModBitInstType       = 33,
    oacModModuleBitInstType = 34,
    oacModNetType           = 35,
    oacModBitNetType        = 36,
    oacModBitTermType       = 37,
    oacOccObjectType        = 38,
    oacOccInstType          = 39,
    oacOccNetType           = 40,
    oacOccBitNetType        = 41,
    oacOccTermType          = 42,
    oacOccBitTermType       = 43,
    oacOccAssignmentType    = 44,
    oacOccConnectDefType    = 45,
    oacOccDesignInstType    = 46,
    oacOccModuleInstType    = 47,
    oacOccBitInstType       = 48,
    oacOccModuleBitInstType = 49,
    oacObjectType           = 50,
    oacConstraintType       = 51,
    oacPropType             = 52,
    oacSessionObjectType    = 53,
    oacValueType            = 54,
    oacAppDefType           = 55,
    oacConstraintDefType    = 56,
    oacDMDataType           = 57,
    oacDMObjectType         = 58,
    oacDMContainerType      = 59,
    oacLibDefListMemType    = 60,
    oacTechObjectType       = 61,
    oacLayerType            = 62,
    oacSiteDefType          = 63,
    oacViaDefType           = 64,
    oacWaferObjectType      = 65,

    oacAbstractTextType     = 66,
    oacAbstractNodeType     = 67,
    oacAbstractOccTextType  = 68,

    oacViaVariantType       = 69,
    oacViaVariantHeaderType = 70,

    oacGroupDefType         = 71
};



// *****************************************************************************
// oaDBTypeEnum
//
// The second entry is a special DBType that is used for objects that are not
// specific to any database type.
//
// Note: The number of types should not include the special database type.
// *****************************************************************************
#define oavNumDBTypes     6

enum oaDBTypeEnum {
    oacFutureDBType     = UINT_MAX - 1,
    oacBaseDBType       = UINT_MAX,
    oacDesignDBType     = 0,
    oacTechDBType       = 1,
    oacLibDBType        = 2,
    oacWaferDBType      = 3,
    oacSessionDBType    = 4,
    oacDMDataDBType     = 5
};



// *****************************************************************************
// oaCategoryTypeEnum
// *****************************************************************************
#define oavNumCategories            18

enum oaCategoryEnum {
    oacFutureCategory               = 0,
    oacConstraintCategory           = 1,
    oacValueCategory                = 2,
    oacAnnotationCategory           = 3,
    oacApplicationDefinedCategory   = 4,
    oacNameCategory                 = 5,
    oacObserverCategory             = 6,
    oacDesignManagementCategory     = 7,
    oacTechCategory                 = 8,
    oacWaferCategory                = 9,
    oacDesignHierarchyCategory      = 10,
    oacGeometryCategory             = 11,
    oacPlaceAndRouteCategory        = 12,
    oacConnectivityCategory         = 13,
    oacParasiticsCategory           = 14,
    oacPlugInCategory               = 15,
    oacGroupManagementCategory      = 16,
    oacViaVariantCategory           = 17
};



// *****************************************************************************
// oaDataModelModTypeEnum
// *****************************************************************************
#define oavNumDataModelModTypes     4

enum oaDataModelModTypeEnum {
    oacFutureDataModelModType   = 0,
    oacAdditionDataModelModType = 1,
    oacRemovalDataModelModType  = 2,
    oacChangeDataModelModType   = 3
};



// *****************************************************************************
// oaType
// *****************************************************************************
class OA_BASE_DLL_API oaType {
public:
                            oaType();
                            oaType(oaTypeEnum valueIn);
                            oaType(const oaString &name);
                            ~oaType();

    const oaString          &getName() const;
                            operator                oaTypeEnum() const;

private:
    static const oaString   *initNames();

    oaTypeEnum              value;

    static const oaString   names[];
};



// *****************************************************************************
// oaDBType
// *****************************************************************************
class OA_BASE_DLL_API oaDBType {
public:
                            oaDBType();
                            oaDBType(oaDBTypeEnum typeIn);
                            oaDBType(const oaString &name);
                            ~oaDBType();

    const oaString          &getName() const;
                            operator                oaDBTypeEnum() const;

private:
    static const oaString   *initVarNames();

    oaDBTypeEnum            value;

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



// *****************************************************************************
// oaCatagory
// *****************************************************************************
class OA_BASE_DLL_API oaCategory {
public:
                            oaCategory();
                            oaCategory(oaCategoryEnum typeIn);
                            oaCategory(const oaString &name);
                            ~oaCategory();

    const oaString          &getName() const;
                            operator                oaCategoryEnum() const;

private:
    static const oaString   *initNames();

    oaCategoryEnum          value;

    static const oaString   *names;
};



// *****************************************************************************
// oaDataModelModType
// *****************************************************************************
class OA_BASE_DLL_API oaDataModelModType {
public:
                            oaDataModelModType();
                            oaDataModelModType(oaDataModelModTypeEnum typeIn);
                            oaDataModelModType(const oaString &name);
                            ~oaDataModelModType();

    const oaString          &getName() const;
                            operator                oaDataModelModTypeEnum() const;

private:
    static const oaString   *initNames();

    oaDataModelModTypeEnum  value;

    static const oaString   *names;
};



// *****************************************************************************
// oaAbstractType
// *****************************************************************************
class OA_BASE_DLL_API oaAbstractType {
public:
                            oaAbstractType();
                            oaAbstractType(oaAbstractTypeEnum valueIn);
                            oaAbstractType(const oaString &name);
                            ~oaAbstractType();

    const oaString          &getName() const;
                            operator                oaAbstractTypeEnum() const;

private:
    static const oaString   *initNames();

    oaAbstractTypeEnum      value;
};



// *****************************************************************************
// oaManagedType
// *****************************************************************************
class OA_BASE_DLL_API oaManagedType {
public:
                            oaManagedType();
                            oaManagedType(oaTypeEnum valueIn);
                            oaManagedType(oaAbstractTypeEnum valueIn);
                            oaManagedType(const oaString &name);
                            ~oaManagedType();

    const oaString          &getName() const;
    oaBoolean               isConcrete() const;
    oaAbstractType          getAbstractType() const;
    oaType                  getConcreteType() const;

    oaBoolean               isValid(oaType testType) const;

    oaBoolean               operator>(const oaManagedType &rhs) const;
    oaBoolean               operator==(const oaManagedType &rhs) const;
    oaBoolean               operator!=(const oaManagedType &rhs) const;

private:
    oaUInt4                 value;
};



END_OA_NAMESPACE

#endif

Return to top of page

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