oaViaParam.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaViaParam.h
//
// This file contains the definitions for the oaViaParam class and its public
// supporting classes. The oaViaParam is used for specified the parameters to
// oaStdViaDef and oaStdVia.
//
//  oaViaParamType
//      This class implements an enumerated type that identifies each parameter
//      field in the oaViaParam.
//
// *****************************************************************************
// 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(oaViaParam_P)
#define oaViaParam_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaVector.h"
#include "oaTechDBTypes.h"



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


// *****************************************************************************
// oaViaParamTypeEnum
// *****************************************************************************
#define oavNumViaParamTypes     14

enum oaViaParamTypeEnum {
    oacLayer1EncViaParamType    = 0,
    oacLayer2EncViaParamType    = 1,
    oacImplant1EncViaParamType  = 2,
    oacImplant2EncViaParamType  = 3,
    oacLayer1OffsetViaParamType = 4,
    oacLayer2OffsetViaParamType = 5,
    oacCutSpacingViaParamType   = 6,
    oacOriginOffsetViaParamType = 7,
    oacCutSizeViaParamType      = 8, // This enumeration value is deprecated.
    oacCutLayerViaParamType     = 9,
    oacCutColumnsViaParamType   = 10,
    oacCutRowsViaParamType      = 11,
    oacCutWidthViaParamType     = 12,
    oacCutHeightViaParamType    = 13
};



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

    const oaString          &getName() const;

                            operator                oaViaParamTypeEnum() const;

private:
    oaViaParamTypeEnum      value;

    static const oaString   names[];
};



// *****************************************************************************
// oaViaParam
// *****************************************************************************
class OA_TECH_DLL_API oaViaParam {
public:
                            oaViaParam();
                            oaViaParam(const oaViaParam &paramIn);
                            ~oaViaParam();

    const oaVector          &getLayer1Enc() const;
    const oaVector          &getLayer2Enc() const;
    const oaVector          &getImplant1Enc() const;
    const oaVector          &getImplant2Enc() const;
    const oaVector          &getLayer1Offset() const;
    const oaVector          &getLayer2Offset() const;
    const oaVector          &getCutSpacing() const;
    const oaVector          &getOriginOffset() const;
    oaDist                  getCutWidth() const;
    oaDist                  getCutHeight() const;
    oaLayerNum              getCutLayer() const;
    oaUInt4                 getCutColumns() const;
    oaUInt4                 getCutRows() const;
    oaBoolean               getCutPatternVal(oaUInt4    cutRowNum,
                                             oaUInt4    cutColNum) const;

    oaBoolean               hasDefaultCutPattern() const;

    void                    setLayer1Enc(const oaVector &layer1Enc);
    void                    setLayer2Enc(const oaVector &layer2Enc);
    void                    setImplant1Enc(const oaVector &imp1Enc);
    void                    setImplant2Enc(const oaVector &imp2Enc);
    void                    setLayer1Offset(const oaVector &layer1Offset);
    void                    setLayer2Offset(const oaVector &layer2Offset);
    void                    setCutSpacing(const oaVector &cutSpacing);
    void                    setOriginOffset(const oaVector &originOffset);
    void                    setCutWidth(oaDist width);
    void                    setCutHeight(oaDist height);
    void                    setCutLayer(oaLayerNum cutLayer);
    void                    setCutColumns(oaUInt4 cutColumns);
    void                    setCutRows(oaUInt4 cutRows);
    void                    setDefaultCutPattern();
    void                    setCutPatternVal(oaUInt4    cutRowNum,
                                             oaUInt4    cutColNum,
                                             oaBoolean  val);

    oaBoolean               hasDefault(oaViaParamType paramType) const;
    oaBoolean               hasAnyDefaults() const;
    void                    setDefault(oaViaParamType paramType);
    void                    setAllNonDefault();

    oaBoolean               isEqual(const oaViaParam &params) const;

    oaViaParam              &operator=(const oaViaParam &params);

    oaBoolean               operator==(const oaViaParam &param) const;
    oaBoolean               operator!=(const oaViaParam &param) const;

private:
    void                    allocCutPattern(oaUInt4 sizeIn);
    void                    freeCutPattern();

    oaVector                layer1Enc;
    oaVector                layer2Enc;
    oaVector                imp1Enc;
    oaVector                imp2Enc;
    oaVector                layer1Offset;
    oaVector                layer2Offset;
    oaVector                cutSpacing;
    oaVector                originOffset;
    oaDist                  cutWidth;
    oaDist                  cutHeight;
    oaLayerNum              cutLayer;
    oaUInt4                 cutColumns;
    oaUInt4                 cutRows;
    oaUInt4                 flags;
    oaUInt4                 cutPatternSize;
    oaByte                  *cutPattern;

    friend class oaDesign;
    friend class oaStdVia;
    friend class oaStdViaHeader;
    friend class oaStdViaDef;
    friend class oaStdViaVariant;
};



END_OA_NAMESPACE

#endif

Return to top of page

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