oaDMTypes.h

Go to the documentation of this file.

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



#if !defined(oaDMTypes_P)
#define oaDMTypes_P

// *****************************************************************************
// Header Files.
// *****************************************************************************
#include "oaString.h"



// *****************************************************************************
// System includes.
// *****************************************************************************
#include <limits.h>

BEGIN_OA_NAMESPACE



// *****************************************************************************
// Windows DLL export macros
// *****************************************************************************
#if defined(OA_WINDOWS) && defined(OA_DM_DLL_EXPORTS)
#define OA_DM_DLL_API __declspec(dllexport)
#define OA_DM_DLL_PVT __declspec(dllexport)
#define OA_DM_DLL_EXTERN
#elif defined(OA_WINDOWS) && !defined(OA_STATIC)
#define OA_DM_DLL_API __declspec(dllimport)
#define OA_DM_DLL_PVT __declspec(dllimport)
#define OA_DM_DLL_EXTERN extern
#else
#define OA_DM_DLL_API
#define OA_DM_DLL_PVT
#endif



// *****************************************************************************
// oaLibDataTypeEnum
//
// The first two entries are special datatypes that are used for the database
// itself and for all oaAppObjects in the database. The next twelve entries are
// reserved and are common to all databases.  Note that the dataID array for
// dataTbls -- oaLibData::dmDataTblIDs--should match this array.
//
// Note: the number of datatypes should not include the special datatype:
// oacDMLibDataType.
// *****************************************************************************
#define oavNumLibDataTypes              19
#define oavNumNewLibDataTypes           2
#define oavNumVarLibDataTypes           2

enum oaLibDataTypeEnum {
    oacLibDataType                      = UINT_MAX,
    oacLibAppObjectDataType             = UINT_MAX - 1, // Included for base compatibility only.
    oacLibPropDataType                  = 0,
    oacLibGroupDataType                 = 1,
    oacLibGroupMemDataType              = 2,
    oacLibAvatarDataType                = 3,    // Included for base compatibility only.
    oacLibValueDataType                 = 4,    // Included for base compatibility only.
    oacLibConstraintParamDefDataType    = 5,    // Included for base compatibility only.
    oacLibConstraintParamDataType       = 6,    // Included for base compatibility only.
    oacLibConstraintDefDataType         = 7,    // Included for base compatibility only.
    oacLibConstraintDataType            = 8,    // Included for base compatibility only.
    oacLibConstraintGroupDataType       = 9,    // Included for base compatibility only.
    oacLibConstraintGroupMemDataType    = 10,   // Included for base compatibility only.
    oacLibConstraintGroupHeaderDataType = 11,   // Included for base compatibility only.

    oacCellDataType                     = 12,
    oacViewDataType                     = 13,
    oacCellViewDataType                 = 14,
    oacDMFileDataType                   = 15,
    oacLibFeatureDataType               = 16,   // Included for base compatibility only.
    oacLibFeaturePolicyDataType         = 17,   // Included for base compatibility only.
    oacLibGroupDefDataType              = 18
};



// *****************************************************************************
// oaLibDataType
// *****************************************************************************
class OA_DM_DLL_API oaLibDataType {
public:
                            oaLibDataType(oaLibDataTypeEnum valueIn);
                            oaLibDataType(const oaString &name);
                            ~oaLibDataType();

    const oaString          &getName() const;

                            operator                oaLibDataTypeEnum() const;

private:
    static const oaString   *initNames();

    oaLibDataTypeEnum       value;

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



// *****************************************************************************
// oaDMDataTypeEnum
//
// The first two entries are special datatypes that are used for the database
// itself and for all oaAppObjects in the database. The next three entries are
// reserved and are common to all databases.  Note that the dataID array for
// dataTbls -- oaLibData::dmDataTblIDs--should match this array.
//
// Note: the number of datatypes should not include the special datatype:
// oacDMLibDataType.
// *****************************************************************************
#define oavNumDMDataTypes               15
#define oavNumNewDMDataTypes            2
#define oavNumVarDMDataTypes            2

enum oaDMDataTypeEnum {
    oacDMDataDataType                   = UINT_MAX,
    oacDMAppObjectDataType              = UINT_MAX - 1,
    oacDMPropDataType                   = 0,
    oacDMGroupDataType                  = 1,
    oacDMGroupMemDataType               = 2,
    oacDMAvatarDataType                 = 3,    // Included for base compatibility only.
    oacDMValueDataType                  = 4,    // Included for base compatibility only.
    oacDMConstraintParamDefDataType     = 5,    // Included for base compatibility only.
    oacDMConstraintParamDataType        = 6,    // Included for base compatibility only.
    oacDMConstraintDefDataType          = 7,    // Included for base compatibility only.
    oacDMConstraintDataType             = 8,    // Included for base compatibility only.
    oacDMConstraintGroupDataType        = 9,    // Included for base compatibility only.
    oacDMConstraintGroupMemDataType     = 10,   // Included for base compatibility only.
    oacDMConstraintGroupHeaderDataType  = 11,   // Included for base compatibility only.

    oacDMFeatureDataType                = 12,
    oacDMFeaturePolicyDataType          = 13,
    oacDMGroupDefDataType               = 14
};



// *****************************************************************************
// oaDMDataType
// *****************************************************************************
class OA_DM_DLL_API oaDMDataType {
public:
                            oaDMDataType(oaDMDataTypeEnum valueIn);
                            oaDMDataType(const oaString &name);
                            ~oaDMDataType();

    const oaString          &getName() const;

                            operator                oaDMDataTypeEnum() const;

private:
    static const oaString   *initNames();

    oaDMDataTypeEnum        value;

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



// *****************************************************************************
// Status bits for Version Control queries on DM objects
// *****************************************************************************
#define oacVCStatusControlled   0x00000001u
#define oacVCStatusEditable     0x00000002u
#define oacVCStatusUpToDate     0x00000004u
#define oacVCStatusAdded        0x00000008u
#define oacVCStatusDeleted      0x00000010u
#define oacVCStatusModified     0x00000020u
#define oacVCStatusLocked       0x00000040u
#define oacVCStatusMerged       0x00000080u
#define oacVCStatusConflict     0x00000100u
#define oacVCStatusMissing      0x00000200u
#define oacVCStatusRemote       0x00000400u

#define oacVCStatusAll          0xFFFFFFFFu



// *****************************************************************************
// Forward Private Class Declarations
// *****************************************************************************
class oaCellViewTbl;
class oaViewTbl;
class oaClient;
class oaDMFileTbl;
class oaDMStaticVarMemory;
class oaLibHashTbl;
class oaLibData;
class oaLibDefListTbl;
class oaLibDefListMemTbl;
class oaDMDataTbl;
class oaDMILink;
class oaDMAccess;
class oaVCSystemPvt;
class oaVCVersionPvt;
class oaDMDataHashTbl;



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaLibDefAttrIter;
class oaDMData;
class oaDMObject;
class oaLib;
class oaLibDefList;
class oaLibDefListMem;
class oaLibDef;
class oaLibDefListRef;
class oaCell;
class oaView;
class oaCellView;
class oaDMFile;
class oaServer;
class oaVCSystem;
class oaVCVersion;



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

OA_DM_DLL_API extern void
oaDMInit(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.