oaPlugInDMInterfaces.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPlugInDMInterfaces.h
//
// This file contains the definitions for DM interface classes, and public
// supporting objects. These include:
//
//  ILib
//     This is an abstract class which specifies the interface for the DM
//     library. This interface is used from OA to call the DM library plug-in.
//
//  IDMAccess
//     This is an abstract class which specifies an access interface for DM
//     plug-in components. This interface is used for DM Interface plug-in
//     components to call back to OA DM.
//
//  IAccessControl
//      This is the interface for DM access control plug-in.
//
//  ILocking
//      This is the interface for DM file locking plug-in.
//
//  IDMSystemCaps
//      This is the interface for DM system capacity plug-in.  
//
// *****************************************************************************
// 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(oaPlugInDMInterfaces_P)
#define oaPlugInDMInterfaces_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPlugInDMTypes.h"
#include "oaPlugInIDMObject.h"



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class IDMObject;
class IDMFile;
class ICell;
class ICellView;
class IView;



// *****************************************************************************
// IDMAccess
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMAccess;

class OA_PLUGIN_DLL_API IDMAccess : public IBase {
public:
    enum NameSpace {
        cNativeNS   = 1,
        cWinNS      = 2,
        cUnixNS     = 3
    };

    virtual void            add(IDMObject   *object,
                                bool        checkExistence = false) = 0;

    virtual void            addLeader(IDMFile *file) = 0;

    virtual void            create(IDMObject *object) = 0;

    virtual void            destroy(IDMObject *object) = 0;

    virtual void            getMappedName(NameSpace     fromNS,
                                          const char    *fromName,
                                          NameSpace     toNS,
                                          IString       *&toName) = 0;

    virtual SRef<IDMLib>    getDMLib() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ILib
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ILib;

class OA_PLUGIN_DLL_API ILib : public IBase {
public:
    virtual void            init(const char     *libName,
                                 const char     *libPath,
                                 oaLibModeEnum  libMode,
                                 const char     *writePath,
                                 IDMAccess      *dmAccess,
                                 IAttrIter      *dmAttrs = NULL) = 0;

    virtual bool            libExists(const char *libPath) = 0;

    virtual void            libPreCreate() = 0;
    virtual void            libPostCreate() = 0;
    virtual void            libPreOpen() = 0;
    virtual void            libPostOpen() = 0;
    virtual void            libPreClose() = 0;

    virtual void            cellCreate(const char *cellName) = 0;
    virtual bool            cellFind(const char *cellName) = 0;
    virtual bool            cellValidate(const char *cellName) = 0;
    virtual void            cellPreFind() = 0;
    virtual void            cellValidateDestroy(ICell *cell) = 0;
    virtual void            cellDestroy(ICell *cell) = 0;

    virtual void            viewCreate(const char   *viewName,
                                       const char   *viewType) = 0;
    virtual bool            viewFind(const char *viewName,
                                     const char *viewType) = 0;
    virtual bool            viewValidate(const char *viewName,
                                         const char *viewType) = 0;
    virtual void            viewPreFind(const char *viewName) = 0;
    virtual void            viewPreFind() = 0;
    virtual void            viewValidateDestroy(IView *view) = 0;
    virtual void            viewDestroy(IView *view) = 0;

    virtual void            cellViewCreate(const char   *cName,
                                           const char   *vName,
                                           const char   *vtName) = 0;
    virtual bool            cellViewFind(const char *cName,
                                         const char *vName,
                                         const char *vtName) = 0;
    virtual bool            cellViewFindViewType(const char *cName,
                                                 const char *vName,
                                                 char       *vtName) = 0;
    virtual bool            cellViewValidate(const char *cName,
                                             const char *vName,
                                             const char *vtName) = 0;
    virtual void            cellViewPreFind(ICell *cell) = 0;
    virtual void            cellViewPreFind(IView *view) = 0;
    virtual void            cellViewPreFind() = 0;
    virtual void            cellViewPreSetView(ICellView    *cv,
                                               IView        *view,
                                               IDMFile      *newPrimary) = 0;
    virtual void            cellViewPostSetView(ICellView *cv) = 0;
    virtual void            cellViewValidateDestroy(ICellView *cv) = 0;
    virtual void            cellViewDestroy(ICellView *cv) = 0;

    virtual void            fileCreate(const char   *name,
                                       IDMObject    *parent,
                                       bool         primary) = 0;
    virtual bool            fileFind(const char *name,
                                     IDMObject  *parent) = 0;
    virtual bool            fileValidate(const char *name,
                                         IDMObject  *parent) = 0;
    virtual void            filePreFind(IDMObject *parent) = 0;
    virtual void            filePreSetLeader(IDMFile    *file,
                                             IDMFile    *leader) = 0;
    virtual void            filePostSetLeader(IDMFile *file) = 0;
    virtual void            filePreSetName(IDMFile      *file,
                                           const char   *name) = 0;
    virtual void            filePostSetName(IDMFile *file) = 0;
    virtual void            fileValidateDestroy(IDMFile *file) = 0;
    virtual void            fileDestroy(IDMFile *file) = 0;
    virtual bool            fileGetCache(IDMFile    *file,
                                         IString    *&path) = 0;
    virtual void            fileReleaseCache(IDMFile    *file,
                                             const char *path) = 0;

    virtual void            getPath(IDMFile *file,
                                    IString *&path) = 0;

    virtual void            getTempFile(IDMObject   *dmObject,
                                        bool        sameFileSystem,
                                        IString     *&path) = 0;

    virtual void            getDMSystemName(IString *&dmSystem) = 0;
    virtual void            getAttributes(IAttrIter *&dmAttrs) = 0;

    virtual void            setAttributes(IAttrIter *dmAttrs) = 0;

    virtual void            getPath(IDMFile                 *file,
                                    oaSaveRecoverTypeEnum   type,
                                    IString                 *&path) = 0;
    virtual void            fileCreate(IDMFile                  *file,
                                       oaSaveRecoverTypeEnum    type) = 0;
    virtual void            fileValidateDestroy(IDMFile                 *file,
                                                oaSaveRecoverTypeEnum   type) = 0;
    virtual void            fileDestroy(IDMFile                 *file,
                                        oaSaveRecoverTypeEnum   type) = 0;
    virtual bool            exists(IDMFile                  *file,
                                   oaSaveRecoverTypeEnum    type) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IAccessControl
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IAccessControl;

class OA_PLUGIN_DLL_API IAccessControl : public IBase {
public:
    virtual bool            getAccess(oaLibAccessEnum   accessType,
                                      oa::oaUInt4       timeOut) = 0;
    virtual void            releaseAccess() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ILocking
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ILocking;

class OA_PLUGIN_DLL_API ILocking : public IBase {
public:
    virtual bool            lock(IDMFile *obj) = 0;
    virtual void            unlock(IDMFile *obj) = 0;
    virtual oa::oaUInt4     getLockStatus(IDMFile *obj) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMSystemCaps
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMSystemCaps;

class OA_PLUGIN_DLL_API IDMSystemCaps : public IBase {
public:
    virtual bool            queryCapability(const char *name) = 0;
    virtual bool            getMetric(const char    *name,
                                      oa::oaUInt4   &metric) = 0;
    virtual bool            getMetric(const char    *name,
                                      double        &metric) = 0;

    static const Guid       &getId();
};



END_OA_PLUGIN_NAMESPACE

#endif

Return to top of page

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