oaBoundary.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBoundary.h
//
// This file contains the definition for the oaBoundary, oaAreaBoundary,
// oaPRBoundary, oaSnapBoundary and oaClusterBoundary classes and 
// their public supporting classes. 
//
// *****************************************************************************
// 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(oaBoundary_P)
#define oaBoundary_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPointArray.h"
#include "oaStringArray.h"
#include "oaFig.h"
#include "oaCluster.h"



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



// *****************************************************************************
// oaRowSpacingTypeEnum
// *****************************************************************************
#define oavNumRowSpacingTypes    3

enum oaRowSpacingTypeEnum {
    oacEveryRowSpacingType  = 0,
    oacEvenRowSpacingType   = 1,
    oacOddRowSpacingType    = 2
};



// *****************************************************************************
// oaRowSpacingType
// *****************************************************************************
class OA_DESIGN_DLL_API oaRowSpacingType {
public:
                            oaRowSpacingType(oaRowSpacingTypeEnum typeIn);
                            oaRowSpacingType(const oaString &name);

    const oaString          &getName() const;

                            operator                oaRowSpacingTypeEnum() const;

private:
    oaRowSpacingTypeEnum    type;

    static const oaString   names[];
};



// *****************************************************************************
// oaRowFlipTypeEnum
// *****************************************************************************
#define oavNumRowFlipTypes    3

enum oaRowFlipTypeEnum {
    oacNoRowFlipType    = 0,
    oacEvenRowFlipType  = 1,
    oacOddRowFlipType   = 2
};



// *****************************************************************************
// oaRowFlipType
// *****************************************************************************
class OA_DESIGN_DLL_API oaRowFlipType {
public:
                            oaRowFlipType(oaRowFlipTypeEnum typeIn);
                            oaRowFlipType(const oaString &name);

    const oaString          &getName() const;

                            operator                oaRowFlipTypeEnum() const;

private:
    oaRowFlipTypeEnum       type;

    static const oaString   names[];
};



// *****************************************************************************
// oaCoreBoxSpec
// *****************************************************************************
class OA_DESIGN_DLL_API oaCoreBoxSpec {
public:
                            oaCoreBoxSpec();
                            oaCoreBoxSpec(const oaBox &bBox);
                            oaCoreBoxSpec(const oaCoreBoxSpec &coreBoxSpec);

    oaBox                   &getBBox();
    const oaBox             &getBBox() const;
    oaBoolean               isRowHorizontal() const;
    oaOffset                getRowSpacing() const;
    oaRowSpacingType        getRowSpacingType() const;
    oaRowFlipType           getRowFlipType() const;
    oaSiteDef               *getSiteDef() const;
    void                    getSiteDefName(oaString &name);
    const oaString          &getSiteDefName() const;

    void                    setBBox(const oaBox &bBox);
    void                    setRowHorizontal(oaBoolean isHorizontal);
    void                    setRowSpacing(oaOffset spacing);
    void                    setRowSpacingType(oaRowSpacingType type);
    void                    setRowFlipType(oaRowFlipType flip);
    void                    setSiteDef(oaSiteDef *siteDef);
    void                    setSiteDef(const oaString &name);

    oaUInt4                 getNumRows() const;
    void                    getRowBBox(oaUInt4  rowNum,
                                       oaBox    &bBox) const;

    oaCoreBoxSpec           &operator=(const oaCoreBoxSpec &coreBoxSpec);

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

private:

    oaBox                   bBox;
    oaBoolean               horizontal;
    oaOffset                spacing;
    oaRowSpacingType        spacingType;
    oaRowFlipType           flipType;
    oaSiteDef               *siteDef;
    oaString                siteDefName;
};



// *****************************************************************************
// oaBoundary
// *****************************************************************************
class OA_DESIGN_DLL_API oaBoundary : public oaFig {
public:
    void                    getPoints(oaPointArray &points) const;
#if !defined(OA_DEPRECATED)
    void                    getEdgeNames(oaString *edgeNamesIn) const;
#endif
    oaUInt4                 getNumEdges() const;
    oaBoolean               hasDefaultConstraintGroup() const;
    oaConstraintGroup       *getDefaultConstraintGroup() const;

#if !defined(OA_DEPRECATED)
    void                    setEdges(const oaPointArray &points,
                                     const oaString     *edgeNames = NULL);
#endif

    void                    transform(oaDouble  scale,
                                      oaDouble  angle);

    void                    getEdgeNames(oaStringArray &edgeNamesIn) const;
    void                    setEdges(const oaPointArray     &points,
                                     const oaStringArray    &edgeNames);

    enum {dtIndex = oacBoundaryDataType};
};



// *****************************************************************************
// oaAreaBoundary
// *****************************************************************************
class OA_DESIGN_DLL_API oaAreaBoundary : public oaBoundary {
public:
#if !defined(OA_DEPRECATED)
    static oaAreaBoundary   *create(oaBlock             *block,
                                    const oaString      &name,
                                    const oaPointArray  &points,
                                    const oaString      *edgeNames = NULL);
    static oaAreaBoundary   *create(oaBlock             *block,
                                    const oaPointArray  &points,
                                    const oaString      *edgeNames = NULL);
#endif

    static oaAreaBoundary   *find(const oaBlock     *block,
                                  const oaString    &name);

    void                    getName(oaString &name) const;

    void                    setName(const oaString &name);

    static oaAreaBoundary   *create(oaBlock             *block,
                                    const oaString      &name,
                                    const oaPointArray  &points,
                                    const oaStringArray &edgeNames);
    static oaAreaBoundary   *create(oaBlock             *block,
                                    const oaPointArray  &points,
                                    const oaStringArray &edgeNames);
};



// *****************************************************************************
// oaPRBoundary
// *****************************************************************************
class OA_DESIGN_DLL_API oaPRBoundary : public oaBoundary {
public:
#if !defined(OA_DEPRECATED)
    static oaPRBoundary                     *create(oaBlock             *block,
                                                    const oaPointArray  &points,
                                                    const oaString      *edgeNames = NULL);
#endif

    static oaPRBoundary                     *find(const oaBlock *block);

    oaBoolean                               hasCoreBoxSpec() const;
    oaBoolean                               hasIOBox() const;

    void                                    getCoreBoxSpec(oaCoreBoxSpec &spec) const;
    void                                    getIOBox(oaBox &box) const;

    void                                    setCoreBoxSpec(const oaCoreBoxSpec &spec);
    void                                    setIOBox(const oaBox &box);

    void                                    removeCoreBoxSpec();
    void                                    removeIOBox();

    oaCollection<oaBlockage, oaPRBoundary>  getBlockagesOwnedBy() const;

    static oaPRBoundary                     *create(oaBlock             *block,
                                                    const oaPointArray  &points,
                                                    const oaStringArray &edgeNames);
};



// *****************************************************************************
// oaSnapBoundary
// *****************************************************************************
class OA_DESIGN_DLL_API oaSnapBoundary : public oaBoundary {
public:
#if !defined(OA_DEPRECATED)
    static oaSnapBoundary   *create(oaBlock             *block,
                                    const oaPointArray  &bBox,
                                    const oaString      *edgeNames = NULL);
#endif

    static oaSnapBoundary   *find(const oaBlock *block);

    static oaSnapBoundary   *create(oaBlock             *block,
                                    const oaPointArray  &bBox,
                                    const oaStringArray &edgeNames);
};



// *****************************************************************************
// oaClusterBoundary
// *****************************************************************************
class OA_DESIGN_DLL_API oaClusterBoundary : public oaBoundary {
public:
#if !defined(OA_DEPRECATED)
    static oaClusterBoundary    *create(oaCluster           *cluster,
                                        const oaString      &name,
                                        const oaPointArray  &points,
                                        const oaString      *edgeNames = NULL);
    static oaClusterBoundary    *create(oaCluster           *cluster,
                                        const oaPointArray  &points,
                                        const oaString      *edgeNames = NULL);
#endif

    static oaClusterBoundary    *find(const oaCluster   *cluster,
                                      const oaString    &name);

    oaCluster                   *getCluster() const;

    void                        getName(oaString &name) const;

    void                        setName(const oaString &name);

    static oaClusterBoundary    *create(oaCluster           *cluster,
                                        const oaString      &name,
                                        const oaPointArray  &points,
                                        const oaStringArray &edgeNames);
    static oaClusterBoundary    *create(oaCluster           *cluster,
                                        const oaPointArray  &points,
                                        const oaStringArray &edgeNames);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaBoundary> {
public:
    typedef oaFig                   parentType;
    typedef oaBoundaryModTypeEnum   modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dtIndex = oacBoundaryDataType};
    enum {dataTypeEnumVal = oacBoundaryDataType};
    enum {abstractTypeEnumVal = oacBoundaryType};
};

template<>
class oaTraits<oaAreaBoundary> {
public:
    typedef oaBoundaryModTypeEnum   modTypeType;
    typedef oaBoundary              parentType;
    enum {dtIndex = oacBoundaryDataType};
    enum {dataTypeEnumVal = oacBoundaryDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAreaBoundaryType};
};

template<>
class oaTraits<oaPRBoundary> {
public:
    typedef oaBoundaryModTypeEnum   modTypeType;
    typedef oaBoundary              parentType;
    enum {dtIndex = oacBoundaryDataType};
    enum {dataTypeEnumVal = oacBoundaryDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPRBoundaryType};
};

template<>
class oaTraits<oaSnapBoundary> {
public:
    typedef oaBoundaryModTypeEnum   modTypeType;
    typedef oaBoundary              parentType;
    enum {dtIndex = oacBoundaryDataType};
    enum {dataTypeEnumVal = oacBoundaryDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacSnapBoundaryType};
};

template<>
class oaTraits<oaClusterBoundary> {
public:
    typedef oaBoundaryModTypeEnum   modTypeType;
    typedef oaBoundary              parentType;
    enum {dtIndex = oacBoundaryDataType};
    enum {dataTypeEnumVal = oacBoundaryDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacClusterBoundaryType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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