oaSiteDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaSiteDef.h
//
// This file contains the definition for the oaSiteDef class. The oaSiteDef
// class defines a site at which cells may be placed in a row. A site has a
// name, type, width, and height allowing for the specification of placeable
// objects within a row.
//
// *****************************************************************************
// 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(oaSiteDef_P)
#define oaSiteDef_P



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



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



// *****************************************************************************
// oaSiteDefType
// *****************************************************************************
#define oavNumSiteDefTypes  2

enum oaSiteDefTypeEnum {
    oacPadSiteDefType   = 0,
    oacCoreSiteDefType  = 1
};



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

    const oaString          &getName() const;

                            operator                oaSiteDefTypeEnum() const;

private:
    oaSiteDefTypeEnum       value;

    static const oaString   names[];
};



// *****************************************************************************
// oaSiteRef
// *****************************************************************************
class OA_TECH_DLL_API oaSiteRef {
public:
                            oaSiteRef();
                            oaSiteRef(const oaString    &siteName,
                                      const oaTransform &xform);
                            oaSiteRef(const oaSiteRef &siteRefIn);

    const oaString          &siteName() const;
    const oaTransform       &transform() const;

    oaString                &siteName();
    oaTransform             &transform();

    oaSiteRef               &operator=(const oaSiteRef &dataIn);

    oaBoolean               operator==(const oaSiteRef &other);
    oaBoolean               operator!=(const oaSiteRef &other);
    oaBoolean               operator==(const oaSiteRef &other) const;
    oaBoolean               operator!=(const oaSiteRef &other) const;

private:
    oaString                name;
    oaTransform             xform;
};



// *****************************************************************************
// oaSitePattern
// *****************************************************************************
class OA_TECH_DLL_API oaSitePattern : public oaArray<oaSiteRef> {
public:
                            oaSitePattern(oaUInt4 size = 0);
                            oaSitePattern(const oaSitePattern &pattern);

protected:
    virtual void            copyElements(oaSiteRef          *elementsTo,
                                         const oaSiteRef    *elementsFrom,
                                         oaUInt4            num);
    virtual oaBoolean       cmpElements(const oaSiteRef *elementsOther,
                                        oaUInt4         num) const;
};


// *****************************************************************************
// oaSiteDef
// *****************************************************************************
class OA_TECH_DLL_API oaSiteDef : public oaTechObject {
public:
    static oaSiteDef                        *find(const oaTech      *tech,
                                                  const oaString    &name);
    static oaSiteDef                        *find(const oaTech      *tech,
                                                  const oaString    &name,
                                                  oaBoolean         local);

    void                                    destroy();

    void                                    getName(oaString &name) const;
    oaSiteDefType                           getSiteDefType() const;
    oaUInt4                                 getWidth() const;
    oaUInt4                                 getHeight() const;
    oaBoolean                               isSymmetricInX() const;
    oaBoolean                               isSymmetricInY() const;
    oaBoolean                               isSymmetricInRot() const;

    void                                    setType(oaSiteDefType type);
    void                                    setSymmetricInX(oaBoolean val);
    void                                    setSymmetricInY(oaBoolean val);
    void                                    setSymmetricInRot(oaBoolean val);

    oaCollection<oaRowHeader, oaSiteDef>    getUsedIn() const;

    enum {dtIndex = oacSiteDefDataType};
};



// *****************************************************************************
// oaScalarSiteDef
// *****************************************************************************
class OA_TECH_DLL_API oaScalarSiteDef : public oaSiteDef {
public:
    static oaScalarSiteDef  *create(oaTech          *tech,
                                    const oaString  &name,
                                    oaSiteDefType   type,
                                    oaUInt4         width,
                                    oaUInt4         height,
                                    oaBoolean       isSymmetricInX = false,
                                    oaBoolean       isSymmetricInY = false,
                                    oaBoolean       isSymmetricInRot = false);


    void                    setWidth(oaUInt4 width);
    void                    setHeight(oaUInt4 height);
};



// *****************************************************************************
// oaArraySiteDef
// *****************************************************************************
class OA_TECH_DLL_API oaArraySiteDef : public oaSiteDef {
public:
    static oaArraySiteDef   *create(oaTech              *tech,
                                    const oaString      &name,
                                    oaSiteDefType       type,
                                    const oaSitePattern &sitePattern,
                                    oaBoolean           isSymmetricInX = false,
                                    oaBoolean           isSymmetricInY = false,
                                    oaBoolean           isSymmetricInRot = false);

    void                    getSitePattern(oaSitePattern &sitePattern) const;

    void                    setSitePattern(const oaSitePattern &sitePattern);
};



// *****************************************************************************
// oaTech traits
// *****************************************************************************
template<>
class oaTraits<oaSiteDef> {
public:
    typedef oaTechObject            parentType;
    typedef oaSiteDefModTypeEnum    modTypeType;
    enum {dbType = oacTechDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dtIndex = oacSiteDefDataType};
    enum {dataTypeEnumVal = oacSiteDefDataType};
    enum {abstractTypeEnumVal = oacSiteDefType};
};

template<>
class oaTraits<oaScalarSiteDef> {
public:
    typedef oaSiteDefModTypeEnum    modTypeType;
    typedef oaSiteDef               parentType;
    enum {dtIndex = oacSiteDefDataType};
    enum {dataTypeEnumVal = oacSiteDefDataType};
    enum {dbType = oacTechDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacScalarSiteDefType};
};

template<>
class oaTraits<oaArraySiteDef> {
public:
    typedef oaSiteDefModTypeEnum    modTypeType;
    typedef oaSiteDef               parentType;
    enum {dtIndex = oacSiteDefDataType};
    enum {dataTypeEnumVal = oacSiteDefDataType};
    enum {dbType = oacTechDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacArraySiteDefType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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