oaPurpose.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPurpose.h
//
// This file contains the definition for the oaPurpose class and its public
// supporting classes. The oaPurpose class defines a purpose, later referenced
// when creating physical design data. A purpose consists of a purpose type,
// a purpose name, and a purpose number.
// The supporting classes include:
//
//  oaPurposeType
//      This class implements an enumerated type that describes the purpose
//      type.
//
// Each technology database will have a set of predefined purposes which
// correspond to the eight oaPurpose types. These predefined purposes are
// always available, and may not be changed nor removed. This set of predefined
// purposes is as follows:
//
// Type                         Name            Number
//
// oacDrawingPurposeType        "drawing"       oavPurposeNumberDrawing
// oacFillPurposeType           "fill"          oavPurposeNumberFill
// oacSlotPurposeType           "slot"          oavPurposeNumberSlot
// oacOPCSerifPurposeType       "OPCSerif"      oavPurposeNumberOPCSerif
// oacOPCAntiSerifPurposeType   "OPCAntiSerif"  oavPurposeNumberOPCAntiSerif
// oacAnnotationPurposeType     "annotation"    oavPurposeNumberAnnotation
// oacGapFillPurposeType        "gapFill"       oavPurposeNumberGapFill
// oacRedundantPurposeType      "redundant"     oavPurposeNumberRedundant
// oacAnyPurposeType            "oaAny"         oavPurposeNumberAny
// oacNoPurposeType             "oaNo"          oavPurposeNumberNo
// oacFillOPCPurposeType        "oaFillOPC"     oavPurposeNumberFillOPC
//
// Additional purposes which are added into the tech database by users will be
// of type oacDrawingPurposeType.
//
// *****************************************************************************
// 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(oaPurpose_P)
#define oaPurpose_P



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



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



// *****************************************************************************
// Default Purpose Number defines.
// *****************************************************************************
#define oavPurposeNumberDrawing         0xffffffffu
#define oavPurposeNumberFill            0xfffffffeu
#define oavPurposeNumberSlot            0xfffffffdu
#define oavPurposeNumberOPCSerif        0xfffffffcu
#define oavPurposeNumberOPCAntiSerif    0xfffffffbu
#define oavPurposeNumberAnnotation      0xfffffffau
#define oavPurposeNumberGapFill         0xfffffff9u
#define oavPurposeNumberRedundant       0xfffffff8u
#define oavPurposeNumberAny             0xfffffff7u
#define oavPurposeNumberNo              0xfffffff6u
#define oavPurposeNumberFillOPC         0xfffffff5u



// *****************************************************************************
// oaPurposeTypeEnum
// *****************************************************************************
#define oavNumPurposeTypes              11

enum oaPurposeTypeEnum {
    oacDrawingPurposeType       = 0,
    oacFillPurposeType          = 1,
    oacSlotPurposeType          = 2,
    oacOPCSerifPurposeType      = 3,
    oacOPCAntiSerifPurposeType  = 4,
    oacAnnotationPurposeType    = 5,
    oacGapFillPurposeType       = 6,
    oacRedundantPurposeType     = 7,
    oacAnyPurposeType           = 8,
    oacNoPurposeType            = 9,
    oacFillOPCPurposeType       = 10
};



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

    const oaString              &getName() const;

                                operator                    oaPurposeTypeEnum() const;

    static oaPurposeTypeEnum    get(oaPurposeNum purposeNum);

private:
    static const oaString       *initNames();

    oaPurposeTypeEnum           value;

    static const oaString       names[];
};



// *****************************************************************************
// oaPurpose
// *****************************************************************************
class OA_TECH_DLL_API oaPurpose : public oaTechObject {
public:
    static oaPurpose        *create(oaTech          *tech,
                                    const oaString  &name,
                                    oaPurposeNum    number);

    static oaPurpose        *find(const oaTech      *tech,
                                  const oaString    &name);
    static oaPurpose        *find(const oaTech  *tech,
                                  oaPurposeNum  number);
    static oaPurpose        *find(const oaTech      *tech,
                                  const oaString    &name,
                                  oaBoolean         local);
    static oaPurpose        *find(const oaTech  *tech,
                                  oaPurposeNum  number,
                                  oaBoolean     local);

    static oaPurpose        *get(oaTech         *tech,
                                 oaPurposeType  type);

    void                    destroy();

    oaPurposeNum            getNumber() const;
    void                    getName(oaString &name) const;
    oaPurposeType           getPurposeType() const;

    oaBoolean               isReserved() const;

    void                    setNumber(oaPurposeNum number);
    void                    setName(const oaString &name);

    enum {dtIndex = oacPurposeDataType};
};



// *****************************************************************************
// oaTech traits
// *****************************************************************************
template<>
class oaTraits<oaPurpose> {
public:
    typedef oaTechObject            parentType;
    typedef oaPurposeModTypeEnum    modTypeType;
    enum {dbType = oacTechDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacPurposeDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPurposeType};
    enum {dataTypeEnumVal = oacPurposeDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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