oaPlugInIDMObject.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMIObjectI.h
//
// This file contains the definitions for the DM object interface classes. 
// These objects are used to pass information through the interface. This file 
// contains the interface definitions only. These objects can be implemented
// by either side of the interface. A simple implementation is also provided
// by the interface package.
//
// The following classes are supported:
//
//  IDMObject
//      This is the base class which encapsulates DM object information. 
//      The class hierarchy rooted at oaDMIObject reflects the DM Object 
//      hierarchy. The purpose of each class is to encapsulate the information 
//      needed to find or reconstruct the object, without dependencies on OA 
//      types. It is intended that the objects will be created by the 
//      application or plug-in as needed, passed through the interface, then
//      destructed by the caller after the interface call returns.
//
//  IDMFileIter
//  IDMContainer
//  IDMLib
//  ICell
//  IView
//  ICellView
//  IDMFile
//
//  IDMObjectIter
//      This is a particular expansion of the IIter interface to iterate
//      components via IDMObject interface pointers.
//
//  IAttr
//      This is an abstract class to represent an attribute which is used at
//      the plug-in interface,  specifically DM attribute which is a string 
//      based name-value pair.
//
// *****************************************************************************
// 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: #2 $
//  $Date: 2010/08/24 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDMIObjectI_P)
#define oaDMIObjectI_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPlugInTypes.h"
#include "oaCommonSPtr.h"



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



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



// *****************************************************************************
// IDMObject
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMObject;

class OA_PLUGIN_DLL_API IDMObject : public IBase {
public:
    virtual bool            isContainer() = 0;
    virtual bool            isLib() = 0;
    virtual bool            isCell() = 0;
    virtual bool            isView() = 0;
    virtual bool            isCellView() = 0;
    virtual bool            isDMFile() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMObjectIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMObjectIter;
typedef IIter<IDMObject*, &IID_IDMObjectIter> IDMObjectIter;



// *****************************************************************************
// IDMFileIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMFileIter;
typedef IIter<IDMFile*, &IID_IDMFileIter> IDMFileIter;



// *****************************************************************************
// ICellIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ICellIter;
typedef IIter<ICell*, &IID_ICellIter> ICellIter;



// *****************************************************************************
// IViewIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IViewIter;
typedef IIter<IView*, &IID_IViewIter> IViewIter;



// *****************************************************************************
// ICellViewIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ICellViewIter;

class ICellViewIter : public IBase {
public:
    typedef ICellView       *Type;
    typedef ICellView       IType;

    virtual bool            next(ICellView *&objOut) = 0;
    virtual void            reset() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMFile
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMFile;

class OA_PLUGIN_DLL_API IDMFile : public IDMObject {
public:
    virtual void            getParent(IDMObject *&p) = 0;
    virtual SRef<IString>   getName() = 0;
    virtual void            getLeader(IDMFile *&l) = 0;
    virtual bool            isPrimary() = 0;
    virtual bool            isLeader() = 0;
    virtual void            getFollowers(IDMFileIter *&files) = 0;
    virtual bool            isDMData() = 0;
    virtual bool            isTech() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMContainer
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMContainer;

class OA_PLUGIN_DLL_API IDMContainer : public IDMObject {
public:
    virtual void            getDMFiles(IDMFileIter *&files) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMLib
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMLib;

class OA_PLUGIN_DLL_API IDMLib : public IDMContainer {
public:
    virtual SRef<IString>   getLibName() = 0;

    virtual void            getCells(ICellIter *&cells) = 0;
    virtual void            getViews(IViewIter *&views) = 0;
    virtual void            getCellViews(ICellViewIter *&cellViews) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IDMLibIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IDMLibIter;
typedef IIter<IDMLib*, &IID_IDMLibIter> IDMLibIter;



// *****************************************************************************
// ICell
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ICell;

class OA_PLUGIN_DLL_API ICell : public IDMContainer {
public:
    virtual void            getLib(IDMLib *&l) = 0;
    virtual SRef<IString>   getName() = 0;

    virtual void            getCellViews(ICellViewIter *&cellViews) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IView
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IView;

class OA_PLUGIN_DLL_API IView : public IDMContainer {
public:
    virtual void            getLib(IDMLib *&l) = 0;
    virtual SRef<IString>   getName() = 0;
    virtual SRef<IString>   getViewType() = 0;

    virtual void            getCellViews(ICellViewIter *&cellViews) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ICellView
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ICellView;

class OA_PLUGIN_DLL_API ICellView : public IDMContainer {
public:
    virtual void            getCell(ICell *&c) = 0;
    virtual void            getView(IView *&v) = 0;
    virtual SRef<IString>   getCellName() = 0;
    virtual SRef<IString>   getViewName() = 0;
    virtual SRef<IString>   getViewType() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IAttr
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IAttr;

class OA_PLUGIN_DLL_API IAttr : public IBase {
public:
    virtual SRef<IString>   getName() = 0;
    virtual SRef<IString>   getValue() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IAttrIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IAttrIter;
typedef IIter<IAttr*, &IID_IAttr> IAttrIter;



END_OA_PLUGIN_NAMESPACE



BEGIN_OA_COMMON_NAMESPACE



USE_OA_PLUGIN_NAMESPACE

// *****************************************************************************
// IDTester
// *****************************************************************************
template<>
class IDTester<IDMContainer> {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<IDMLib> {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<ICell> {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<IView> {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<ICellView> {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<IDMFile> {
public:
    static bool             test(const Guid &id);
};



END_OA_COMMON_NAMESPACE

#endif

Return to top of page

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