oaPcellLink.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPcellLink.h
//
// This file contains the definitions for oaPcellLink and oaPcellDef classes:
//
//  oaPcellLink
//     This class is used as an container class for IPcell. IPcell is the
//     pcell processing interface provided by application. An IPcell can be
//     created in memory by the application or through pcell plug-in.
//
//  oaPcellDef
//     This class contain the binding information of the IPcell for the
//     supermaster. It also provides a name/value pair string table for the
//     storing user data to a pcell evaluator. In the oaPcellCPP, the pcell
//     generator name and the masterType indentifing which type master to
//     generate are using this name/value to store in oaPcellDef when
//     a oaPcellCPP supermaster is created.
//
// *****************************************************************************
// 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(oaPcellLink_P)
#define oaPcellLink_P



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



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



// *****************************************************************************
// oaPcellErrorTypeEnum
// *****************************************************************************
enum oaPcellErrorTypeEnum {
    oacPcellBindError           = 0,
    oacPcellUnbindError         = 1,
    oacPcellEvalError           = 2,
    oacPcellReadError           = 3,
    oacPcellWriteError          = 4,
    oacPcellCalcDiskSizeError   = 5,
    oacPcellPlugInError         = 6
};



// *****************************************************************************
// Explicit template instantiations
// *****************************************************************************
#if defined(OA_DESIGN_DLL_EXTERN)
OA_DESIGN_DLL_EXTERN template
 class OA_DESIGN_DLL_API SPtr<IPcell>;
#endif



// *****************************************************************************
// oaPcellLink
// *****************************************************************************
class OA_DESIGN_DLL_API oaPcellLink {
public:
    void                    destroy();
    IPcell                  *getIPcell() const;

    static oaPcellLink      *find(const oaString &name);
    static oaPcellLink      *create(IPcell *pcellIn);
    static oaPcellDef       *getPcellDef(const oaString &name);

private:
                            oaPcellLink(IPcell *pcellIn);

    SPtr<IPcell>            pcell;
    oaPcellLink             *next;
    static oaPcellLink      *first;

    friend class IPcell;
};



struct oaPcellDefData;
#if defined(OA_DESIGN_DLL_EXTERN)
OA_DESIGN_DLL_EXTERN template
 class OA_DESIGN_DLL_API oaArray<oaPcellDefData*>;
#endif




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

    IPcell                      *getIPcell() const;

    virtual oaBoolean           addData(const oaString  &name,
                                        const oaString  &value);
    virtual oaBoolean           removeData(const oaString &name);
    virtual oaBoolean           getDataValue(const oaString &name,
                                             oaString       &value);
    virtual oaBoolean           setDataValue(const oaString &name,
                                             const oaString &value);

private:
    oaPcellDefData              *findData(const oaString &name);

    IPcell                      *pcell;
    oaArray<oaPcellDefData*>    data;
};



END_OA_NAMESPACE



#endif

Return to top of page

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