oaAntennaData.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaAntennaData.h
//
// This file contains the definitions for the oaAntennaModel, oaAntennaArea,
// oaAntennaAreaArray, and oaAntennaData classes.
//
// The oaAntennaModel class implements an enumerated type that describes the
// type of antennaData that can be associated with a terminal. The antennaModel
// reflects the antenna process model corresponding to the antenna data.
//
// The oaAntennaArea class implements an object for holding antennaArea data.
// This data includes an area value in square database units and an optional
// layer number. If the layer number is oacNullIndex, the area is interpreted
// as applying to all layers.
//
// The oaAntennaAreaArray class implements an array of antennaArea values.
//
// The oaAntennaData class implements on object for holding antenna data for
// a particular antennaModel.
//
// *****************************************************************************
// 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-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaAntennaData_P)
#define oaAntennaData_P



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



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



// *****************************************************************************
// oaAntennaArea
// *****************************************************************************
class OA_DESIGN_DLL_API oaAntennaArea {
public:
                            oaAntennaArea(oaUInt8       areaIn = 0u,
                                          oaLayerNum    layerNumIn = oacAnyLayerNum);

    oaUInt8                 &area();
    oaLayerNum              &layerNum();

    oaUInt8                 area() const;
    oaLayerNum              layerNum() const;

    oaBoolean               operator==(const oaAntennaArea &value) const;
    oaBoolean               operator!=(const oaAntennaArea &value) const;

private:
    oaUInt8                 areaVal;
    oaLayerNum              layerNumVal;
};




// *****************************************************************************
// oaAntennaAreaArray
// *****************************************************************************
class OA_DESIGN_DLL_API oaAntennaAreaArray : public oaArray<oaAntennaArea> {
public:
                            oaAntennaAreaArray(oaUInt4 sizeIn = 0);
                            oaAntennaAreaArray(const oaAntennaAreaArray &aIn);

    void                    compress();

    using                   oaArray<oaAntennaArea>::sort;
    void                    sort();
};



// *****************************************************************************
// oaAntennaData
// *****************************************************************************
class OA_DESIGN_DLL_API oaAntennaData {
public:
                                oaAntennaData(const oaAntennaModel &processIn = oacDefaultAntennaModel);
                                oaAntennaData(const oaAntennaData &dataIn);
                                ~oaAntennaData();

    oaAntennaData               &operator=(const oaAntennaData &dataIn);

    const oaAntennaModel        &getModel() const;
    void                        setModel(const oaAntennaModel &modelIn);

    const oaAntennaAreaArray    &gate() const;
    const oaAntennaAreaArray    &diff() const;
    const oaAntennaAreaArray    &partialMetal() const;
    const oaAntennaAreaArray    &partialMetalSide() const;
    const oaAntennaAreaArray    &partialCut() const;
    const oaAntennaAreaArray    &maxCAR() const;
    const oaAntennaAreaArray    &maxSideCAR() const;
    const oaAntennaAreaArray    &maxCutCAR() const;

#if !defined(OA_DEPRECATED)
    oaAntennaAreaArray          &gate();
    oaAntennaAreaArray          &diff();
    oaAntennaAreaArray          &partialMetal();
    oaAntennaAreaArray          &partialMetalSide();
    oaAntennaAreaArray          &partialCut();
    oaAntennaAreaArray          &maxCAR();
    oaAntennaAreaArray          &maxSideCAR();
    oaAntennaAreaArray          &maxCutCAR();
#endif

    void                        setGate(const oaAntennaAreaArray &gate);
    void                        setDiff(const oaAntennaAreaArray &diff);
    void                        setPartialMetal(const oaAntennaAreaArray &partialMetal);
    void                        setPartialMetalSide(const oaAntennaAreaArray &partialMetalSide);
    void                        setPartialCut(const oaAntennaAreaArray &partialCut);
    void                        setMaxCAR(const oaAntennaAreaArray &maxCAR);
    void                        setMaxSideCAR(const oaAntennaAreaArray &maxSideCAR);
    void                        setMaxCutCAR(const oaAntennaAreaArray &maxCutCAR);

private:
    oaAntennaModel              model;
    oaAntennaAreaArray          gateVal;
    oaAntennaAreaArray          diffVal;
    oaAntennaAreaArray          partialMetalVal;
    oaAntennaAreaArray          partialMetalSideVal;
    oaAntennaAreaArray          partialCutVal;
    oaAntennaAreaArray          maxCARVal;
    oaAntennaAreaArray          maxSideCARVal;
    oaAntennaAreaArray          maxCutCARVal;
};



END_OA_NAMESPACE

#endif

Return to top of page

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