oaDMData.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMData.h
//
// This file contains the definition for the oaDMData class. This class is
// used as a database to store properties, appDefs, and groups for DM
// containers. The oaDMData object is opened and referenced using a
// oaDMContainer*.
//
// This file also contains the child classes of oaDMData. There is a child
// class for each kind of container. The child classes are: oaLibData,
// oaCellData, oaViewData, and oaCellViewData. These classes can be referenced
// and opened using the names (and other data) which specify the
// owner/container.
//
// *****************************************************************************
// 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 $
// *****************************************************************************
// *****************************************************************************



#ifndef oaDMData_P
#define oaDMData_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaAppObjectDef.h"
#include "oaView.h"
#include "oaSaveRecover.h"



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



// *****************************************************************************
// Forward class declaration
// *****************************************************************************
class oaDMContainer;




// *****************************************************************************
// oaDMData
// *****************************************************************************
class OA_DM_DLL_API oaDMData : public oaObject {
public:
    static oaDMData                         *open(const oaDMContainer   *container,
                                                  oaChar                mode);
    static oaDMData                         *recover(const oaDMContainer    *container,
                                                     oaSaveRecoverType      saveRecoverType);
    static oaDMData                         *find(const oaDMContainer *container);
    static oaBoolean                        exists(const oaDMContainer *container);
    static oaBoolean                        exists(const oaDMContainer  *container,
                                                   oaSaveRecoverType    saveRecoverType);

    static void                             destroy(const oaDMContainer *container);
    static void                             destroy(const oaDMContainer *container,
                                                    oaSaveRecoverType   saveRecoverType);

    void                                    close();
    void                                    purge();
    void                                    save();
    void                                    save(oaSaveRecoverType saveRecoverType);
    void                                    reopen(oaChar mode);
    void                                    revert();

    void                                    getLibName(oaScalarName &libName) const;
    void                                    getLibName(const oaNameSpace    &ns,
                                                       oaString             &libName) const;
    oaLib                                   *getLib() const;
    oaChar                                  getMode() const;
    oaUInt4                                 getRefCount() const;
    oaTimeStamp                             getTimeStamp(oaDMDataType type) const;

    oaBoolean                               isModified() const;
    oaBoolean                               isRecovered() const;

    static oaUInt4                          getRevNumber();

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

    oaCollection<oaGroup, oaDMData>         getGroups() const;
    oaCollection<oaGroup, oaDMData>         getGroups(oaGroupDef *def) const;
    oaCollection<oaGroup, oaDMData>         getGroupsByName(const oaString &name) const;

    oaCollection<oaAppDef, oaDMData>        getAppDefsByDataType(oaDMDataType dataType) const;
    oaCollection<oaAppObject, oaDMData>     getAppObjects(const oaAppObjectDef *def) const;
    oaCollection<oaAppObjectDef, oaDMData>  getAppObjectDefs() const;

    static oaCollection<oaDMData, oaDMData> getOpenDMDataObjs();

    enum {dtIndex = oacDMDataDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// oaLibDMData
// *****************************************************************************
class OA_DM_DLL_API oaLibDMData : public oaDMData {
public:
    static oaLibDMData      *open(const oaScalarName    &libName,
                                  oaChar                mode);
    static oaLibDMData      *recover(const oaScalarName &libName,
                                     oaSaveRecoverType  saveRecoverType);

    static oaLibDMData      *find(const oaScalarName &libName);
    static oaBoolean        exists(const oaScalarName &libName);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   oaSaveRecoverType    saveRecoverType);

    static void             destroy(const oaScalarName &libName);
    static void             destroy(const oaScalarName  &libName,
                                    oaSaveRecoverType   saveRecoverType);
};



// *****************************************************************************
// oaCellDMData
// *****************************************************************************
class OA_DM_DLL_API oaCellDMData : public oaDMData {
public:
    static oaCellDMData     *open(const oaScalarName    &libName,
                                  const oaScalarName    &cellName,
                                  oaChar                mode);
    static oaCellDMData     *recover(const oaScalarName &libName,
                                     const oaScalarName &cellName,
                                     oaSaveRecoverType  saveRecoverType);

    static oaCellDMData     *find(const oaScalarName    &libName,
                                  const oaScalarName    &cellName);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &cellName);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &cellName,
                                   oaSaveRecoverType    saveRecoverType);

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

    void                    getCellName(oaScalarName &cellName) const;
    void                    getCellName(const oaNameSpace   &ns,
                                        oaString            &cellName) const;
};



// *****************************************************************************
// oaViewDMData
// *****************************************************************************
class OA_DM_DLL_API oaViewDMData : public oaDMData {
public:
    static oaViewDMData     *open(const oaScalarName    &libName,
                                  const oaScalarName    &viewName,
                                  const oaViewType      *viewType,
                                  oaChar                mode);
    static oaViewDMData     *recover(const oaScalarName &libName,
                                     const oaScalarName &viewName,
                                     oaSaveRecoverType  saveRecoverType);

    static oaViewDMData     *find(const oaScalarName    &libName,
                                  const oaScalarName    &viewName,
                                  const oaViewType      *viewType);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &viewName,
                                   const oaViewType     *viewType);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &viewName,
                                   oaSaveRecoverType    saveRecoverType);

    static void             destroy(const oaScalarName  &libName,
                                    const oaScalarName  &viewName,
                                    const oaViewType    *viewType);
    static void             destroy(const oaScalarName  &libName,
                                    const oaScalarName  &viewName,
                                    oaSaveRecoverType   saveRecoverType);

    void                    getViewName(oaScalarName &viewName) const;
    void                    getViewName(const oaNameSpace   &ns,
                                        oaString            &viewName) const;
    oaViewType              *getViewType() const;
};



// *****************************************************************************
// oaCellViewDMData
// *****************************************************************************
class OA_DM_DLL_API oaCellViewDMData : public oaDMData {
public:
    static oaCellViewDMData *open(const oaScalarName    &libName,
                                  const oaScalarName    &cellName,
                                  const oaScalarName    &viewName,
                                  const oaViewType      *viewType,
                                  oaChar                mode);
    static oaCellViewDMData *open(const oaScalarName    &libName,
                                  const oaScalarName    &cellName,
                                  const oaScalarName    &viewName,
                                  oaChar                mode);
    static oaCellViewDMData *recover(const oaScalarName &libName,
                                     const oaScalarName &cellName,
                                     const oaScalarName &viewName,
                                     oaSaveRecoverType  saveRecoverType);

    static oaCellViewDMData *find(const oaScalarName    &libName,
                                  const oaScalarName    &cellName,
                                  const oaScalarName    &viewName);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &cellName,
                                   const oaScalarName   &viewName);
    static oaBoolean        exists(const oaScalarName   &libName,
                                   const oaScalarName   &cellName,
                                   const oaScalarName   &viewName,
                                   oaSaveRecoverType    saveRecoverType);

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

    void                    getCellName(oaScalarName &cellName) const;
    void                    getCellName(const oaNameSpace   &ns,
                                        oaString            &cellName) const;
    void                    getViewName(oaScalarName &viewName) const;
    void                    getViewName(const oaNameSpace   &ns,
                                        oaString            &viewName) const;
    oaViewType              *getViewType() const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaDMData> {
public:
    typedef oaObject        parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dataTypeEnumVal = oacDMDataDataType};
    enum {dbType = oacDMDataDBType};
    enum {abstractTypeEnumVal = oacDMDataType};
};


template<>
class oaTraits<oaLibDMData> {
public:
    typedef oaDMData        parentType;
    enum {dataTypeEnumVal = oacDMDataDataType};
    enum {dbType = oacDMDataDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {objectTypeEnumVal = oacLibDMDataType};
    enum {isConcrete = true};
};

template<>
class oaTraits<oaCellDMData> {
public:
    typedef oaDMData        parentType;
    enum {dataTypeEnumVal = oacDMDataDataType};
    enum {dbType = oacDMDataDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {objectTypeEnumVal = oacCellDMDataType};
    enum {isConcrete = true};
};

template<>
class oaTraits<oaViewDMData> {
public:
    typedef oaDMData        parentType;
    enum {dataTypeEnumVal = oacDMDataDataType};
    enum {dbType = oacDMDataDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {objectTypeEnumVal = oacViewDMDataType};
    enum {isConcrete = true};
};

template<>
class oaTraits<oaCellViewDMData> {
public:
    typedef oaDMData        parentType;
    enum {dataTypeEnumVal = oacDMDataDataType};
    enum {dbType = oacDMDataDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {objectTypeEnumVal = oacCellViewDMDataType};
    enum {isConcrete = true};
};


END_OA_NAMESPACE

#endif

Return to top of page

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