oaDerivedLayerParamDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDerivedLayerParamDef.h
//
// This file contains the definition for the following classes
//      oaDerivedLayerParamType
//          This is an enum wrapper class for oaDerivedLayerParamTypeEnum. The 
//          enum values are used when creating oaDerivedLayerParamDef class 
//          objects.
//      oaDerivedLayerConnectivityType
//          This is a wrapper class for oaDerivedLayerConnectivityTypeEnum. The 
//          enum values represent the types of connection of shapes to a net.
//      oaDerivedLayerParamDef
//          This class is used to get built in parameters or create user defined 
//          parameters for derived layers. These definitions enforce the values
//          associated with the derived layer parameters.
//
// *****************************************************************************
// 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 2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDerivedLayerParamDef_P)
#define oaDerivedLayerParamDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaTech.h"



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



// *****************************************************************************
// oaDerivedLayerParamTypeEnum
// *****************************************************************************
#define oavNumDerivedLayerParamTypes  7

enum oaDerivedLayerParamTypeEnum {
    oacConnectivityTypeDerivedLayerParamType        = 0,
    oacSelectShapesInRangeDerivedLayerParamType     = 1,
    oacRangeDerivedLayerParamType                   = 2,
    oacAreaRangeDerivedLayerParamType               = 3,
    oacExclusiveDerivedLayerParamType               = 4,
    oacDistanceDerivedLayerParamType                = 5,
    oacSelectShapesWithPurposeDerivedLayerParamType = 6
};



// *****************************************************************************
// oaDerivedLayerConnectivityTypeEnum
// *****************************************************************************
#define oavNumDerivedLayerConnectivityTypes  3

enum oaDerivedLayerConnectivityTypeEnum {
    oacSameNetDerivedLayerConnectivityType      = 0,
    oacDifferentNetDerivedLayerConnectivityType = 1,
    oacIgnoreDerivedLayerConnectivityType       = 2
};



// *****************************************************************************
// oaDerivedLayerParamType
// *****************************************************************************
class OA_TECH_DLL_API oaDerivedLayerParamType {
public:
                                oaDerivedLayerParamType(oaDerivedLayerParamTypeEnum valueIn);
                                oaDerivedLayerParamType(const oaString &name);
                                ~oaDerivedLayerParamType();

    const oaString              &getName() const;
                                operator                    oaDerivedLayerParamTypeEnum() const;

private:
    static const oaString       *initNames();

    oaDerivedLayerParamTypeEnum value;

    static const oaString       *names;
};



// *****************************************************************************
// oaDerivedLayerConnectivityType
// *****************************************************************************
class OA_TECH_DLL_API oaDerivedLayerConnectivityType {
public:
                                        oaDerivedLayerConnectivityType(oaDerivedLayerConnectivityTypeEnum valueIn);
                                        oaDerivedLayerConnectivityType(const oaString &name);
                                        ~oaDerivedLayerConnectivityType();

    const oaString                      &getName() const;
                                        operator                    oaDerivedLayerConnectivityTypeEnum() const;

private:
    static const oaString               *initNames();

    oaDerivedLayerConnectivityTypeEnum  value;

    static const oaString               *names;
};



// *****************************************************************************
// oaDerivedLayerParamDef
// *****************************************************************************
class OA_TECH_DLL_API oaDerivedLayerParamDef : public oaSessionObject {
public:
    static oaDerivedLayerParamDef   *create(const oaString  &name,
                                            oaType          valueType);
    static oaDerivedLayerParamDef   *get(oaDerivedLayerParamType type);
    static oaDerivedLayerParamDef   *find(const oaString &name);

    void                            getName(oaString &name) const;
    oaType                          getValueType() const;
    oaBoolean                       isBuiltIn() const;

    void                            destroy();
    void                            remove(oaTech *tech);
};



// *****************************************************************************
// Tech objects derived from oaSessionObject
// *****************************************************************************
template<>
class oaTraits<oaDerivedLayerParamDef> {
public:
    typedef oaSessionObject             parentType;
    typedef oaDerivedLayerParamDefTbl   tblType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacDerivedLayerParamDefType};
};



#if defined(OA_TECH_DLL_EXTERN)

OA_TECH_DLL_EXTERN template
 class OA_TECH_DLL_API oaCollection<oaDerivedLayerParamDef, oaSession>;

#endif



END_OA_NAMESPACE

#endif

Return to top of page

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