oaDesignInterfaces.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDesignInterfaces.h
//
// This file contains the definitions for design interface classes:
//
//  IRCBase
//     This intermediate base class allows enabling and disabling the reference
//     counting for specific period of time within an application.
//
//  IPcell
//     The IPcell class implements the interfaces required to build and maintain
//     parameterized cells in the OpenAccess database. Any application that
//     wants to provide parameterized cells as a feature is required to derive
//     from this class. The derived class is identified as a pcell evaluator.
//     An IPcell can be provided in memory or through a plug-in module. When the
//     IPcell is provided in memory, the application needs to create its IPcell
//     derived class and call oaPcellLink::create() to register with OpenAccess.
//     For IPcell provided through a plug-in module, oaPcellLink::find() and
//     oaPcellLink::getPcellDef() can be used to access the IPcell in the 
//     plug-in module.
//
//  IPcellGen
//     The IPcellGen class is an interface for application to hookup with an
//     IPcell to provide the content generation on a subMaster. The content
//     generation on a subMaster is identified as a pcell generator. oaPcellCPP
//     uses this interface as the link between the evaluator and generator.
//
//  PcellFile
//     The PcellFile class is an utility class for the IPcell interface users
//     to read/write a pcell subMaster if they choose to do so.
//
//  IEvalText
//     The IEvalText class implements a callback used by an oaEvalText object to
//     interpret the text string. Any application that wants to customize the
//     oaEvalText text interpretation as a feature is required to derive from
//     this class. An IEvalText can be provided in memory or through a plug-in
//     module. When the IEvalText is provided in memory, the application needs
//     to create its IEvalText derived class and call oaEvalTextLink::create()
//     to register with OpenAccess. For IEvalText provided through a plug-in
//     module, oaEvalTextLink::find() can be used to access the IEvalText in
//     the plug-in module.
//
//  ITextInvalidate
//     The ITextInvalidate class is an interface that is used by text bBox 
//     components to invalidate the bounding box of an oaText, oaTextDisplay 
//     or all text objects in a block.
//
//  IText 
//     The IText class is an interface that is used by an oaText or
//     oaTextDisplay object to find the bounding box of the object. Any 
//     application that wants to customize the bounding box calculations has to
//     to implement this interface by defining a class derived from
//     this interface. An IText implementation can be provided in memory or 
//     through a plug-in module. Applications may initialize their bBox
//     component with OpenAccess.
//
// *****************************************************************************
// 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-2009 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDesignInterface_P)
#define oaDesignInterface_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCommonIBase.h"
#include "oaMapWindow.h"
#include "oaTextDisplay.h"



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



// *****************************************************************************
// IPcell
// *****************************************************************************
class OA_DESIGN_DLL_API IPcell : public IBase {
public:
    virtual                 ~IPcell();

    virtual oaPcellDef      *getPcellDef() = 0;

    virtual void            getName(oaString &name) = 0;

    virtual void            onBind(oaDesign     *design,
                                   oaPcellDef   *pcellDef) = 0;
    virtual void            onUnbind(oaDesign   *design,
                                     oaPcellDef *pcellDef) = 0;

    virtual void            onEval(oaDesign     *design,
                                   oaPcellDef   *pcellDef) = 0;

    virtual void            onRead(oaDesign         *design,
                                   oaMapFileWindow  &mapWindow,
                                   oaUInt4          &loc,
                                   oaPcellDef       *pcellDef) = 0;
    virtual void            onWrite(oaDesign        *design,
                                    oaMapFileWindow &mapWindow,
                                    oaUInt4         &loc,
                                    oaPcellDef      *pcellDef) = 0;

    virtual oaUInt4         calcDiskSize(oaPcellDef *pcellDef) const = 0;


    static const Guid       &getId();
};



// *****************************************************************************
// IPcellGen
// *****************************************************************************
class OA_DESIGN_DLL_API IPcellGen : public IBase {
public:
    virtual void            genPcell(const oaString &masterType,
                                     oaDesign       *design,
                                     oaPcellDef     *pcellDef) = 0;

    static const Guid       &getId();

};



// *****************************************************************************
// PcellFile
// *****************************************************************************
class OA_DESIGN_DLL_API PcellFile {
public:
                            PcellFile(const oaString &fileName);
                            ~PcellFile();

    void                    open(oaChar mode);
    void                    close();

    void                    read(oaDesign   *subMaster,
                                 oaUInt8    offset);
    oaUInt8                 append(oaDesign *subMaster);

    oaUInt8                 getSize() const;

private:
    void                    *impl;
};



// *****************************************************************************
// IEvalText
// *****************************************************************************
class OA_DESIGN_DLL_API IEvalText : public IBase {
public:
    virtual                 ~IEvalText();

    virtual void            getName(oaString &name) = 0;

    virtual void            onEval(const oaString   &textIn,
                                   oaString         &textOut) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ITextInvalidate
// *****************************************************************************
class OA_DESIGN_DLL_API ITextInvalidate : public IBase {
public:

    virtual void            invalidate(oaText *text) = 0;
    virtual void            invalidate(oaTextDisplay *textDisplay) = 0;
    virtual void            invalidate(oaBlock *blk) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IText
// *****************************************************************************
class OA_DESIGN_DLL_API IText : public IBase {
public:
    virtual void            getName(oaString &name) = 0;

    virtual void            getBBox(const oaText    *text,
                                    oaBox           &bBox) = 0;

    virtual void            getBBox(const oaTextDisplay *textDisplay,
                                    oaBox               &bBox) = 0;

    virtual void            init(ITextInvalidate *textInvalidate) = 0;

    void                    disableRefCounting(bool val);

    static const Guid       &getId();
};



END_OA_NAMESPACE

#endif

Return to top of page

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