oaArrayInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaArrayInst.h
//
// This file contains the definition for the oaArrayInst class. This class
// implements an object that represents an array of instances of one master
// design. Every cell in the array has the same orientation. The arrayInst is
// primarily used in the physical layout design as it can be used to represent
// an array of memory cells.
//
// The oaArrayInst object should not be used to represent logical connectivity
// as it is considered a single-bit instance.
//
// *****************************************************************************
// 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(oaArrayInst_P)
#define oaArrayInst_P



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



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



// *****************************************************************************
// oaArrayInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaArrayInst : public oaBitInst {
public:
    static oaArrayInst      *create(oaBlock             *block,
                                    oaDesign            *master,
                                    const oaScalarName  &name,
                                    const oaTransform   &xform,
                                    oaOffset            dX,
                                    oaOffset            dY,
                                    oaUInt4             numRows,
                                    oaUInt4             numCols,
                                    const oaParamArray  *params = NULL,
                                    oaPlacementStatus   status = oacNonePlacementStatus);
    static oaArrayInst      *create(oaBlock             *block,
                                    oaDesign            *master,
                                    const oaTransform   &xform,
                                    oaOffset            dX,
                                    oaOffset            dY,
                                    oaUInt4             numRows,
                                    oaUInt4             numCols,
                                    const oaParamArray  *params = NULL,
                                    oaPlacementStatus   status = oacNonePlacementStatus);
    static oaArrayInst      *create(oaBlock             *block,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    const oaScalarName  &name,
                                    const oaTransform   &xform,
                                    oaOffset            dX,
                                    oaOffset            dY,
                                    oaUInt4             numRows,
                                    oaUInt4             numCols,
                                    const oaParamArray  *params = NULL,
                                    oaPlacementStatus   status = oacNonePlacementStatus);
    static oaArrayInst      *create(oaBlock             *block,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    const oaTransform   &xform,
                                    oaOffset            dX,
                                    oaOffset            dY,
                                    oaUInt4             numRows,
                                    oaUInt4             numCols,
                                    const oaParamArray  *params = NULL,
                                    oaPlacementStatus   status = oacNonePlacementStatus);

    static oaArrayInst      *find(const oaBlock         *block,
                                  const oaScalarName    &name);
    static oaBoolean        isValidName(oaBlock             *block,
                                        const oaScalarName  &name);

    oaOffset                getDX() const;
    oaOffset                getDY() const;
    oaUInt4                 getNumRows() const;
    oaUInt4                 getNumCols() const;
    void                    getName(oaScalarName &name) const;
    void                    getName(const oaNameSpace   &ns,
                                    oaString            &name) const;

    using                   oaBitInst::getBBox;
    void                    getBBox(oaUInt4 row,
                                    oaUInt4 col,
                                    oaBox   &bBox) const;

    void                    getTransform(oaUInt4        row,
                                         oaUInt4        col,
                                         oaTransform    &xform) const;
    void                    getOverlap(const oaBox  &region,
                                       oaDist       &xMin,
                                       oaDist       &xMax,
                                       oaDist       &yMin,
                                       oaDist       &yMax) const;

    void                    setDX(oaOffset dX);
    void                    setDY(oaOffset dY);
    void                    setNumRows(oaUInt4 numRows);
    void                    setNumCols(oaUInt4 numCols);
    void                    setName(const oaScalarName &name);

    using                   oaInst::copy;
    oaArrayInst             *copy(const oaScalarName    &name,
                                  const oaTransform     &xform);
    oaArrayInst             *copy(const oaScalarName    &name,
                                  const oaTransform     &xform,
                                  oaBlock               *block);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaArrayInst> {
public:
    typedef oaInstModTypeEnum   modTypeType;
    typedef oaBitInst           parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacArrayInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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