oaOccShape.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccShape.h
//
// This file contains the definitions for the oaOccShape class and its 
// supporting classes. The oaOccShape object represents an unique occurrence 
// of an oaShape object in a design hierarchy. Each type of oaShape will have
// corresponding oaOccShape classes, these classes include:
//
//  oaOccArc
//  oaOccDonut
//  oaOccDot
//  oaOccEllipse
//  oaOccLine
//  oaOccPath
//  oaOccPathSeg
//  oaOccPolygon
//  oaOccRect
//  oaOccText
//  oaOccEvalText
//  oaOccTextDisplay
//  oaOccPropDisplay
//  oaOccAttrDisplay
//  oaOccTextOverride
//  oaOccInstPropDisplay
//  oaOccInstAttrDisplay
//
// The oaOccShape class has read-only interface, this means oaOccShape objects
// cannot be saved persistently, cannot have properties attached to them, and
// cannot be assigned to groups.
//
// oaOccShapes are dynamically generated; applications are responsible for 
// notifying OpenAccess to free the resources associated with each oaOccShape
// object.
//
// *****************************************************************************
// 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(oaOccShape_P)
#define oaOccShape_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaLPPHeader.h"
#include "oaPath.h"
#include "oaSegStyle.h"
#include "oaTextDisplay.h"
#include "oaHierPath.h"
#include "oaPin.h"



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



// *****************************************************************************
// oaOccShape
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccShape : public oaBlockObject {
public:
    static oaOccShape       *get(oaShape            *shape,
                                 oaDesign           *topDesign,
                                 const oaHierPath   &hierPath);

    oaShape                 *getShape() const;
    void                    getBBox(oaBox &bBox) const;
    void                    getHierPath(oaHierPath &hierPath) const;
    oaLPPHeader             *getHeader() const;
    oaLayerNum              getLayerNum() const;
    oaPurposeNum            getPurposeNum() const;
    oaRouteStatus           getRouteStatus() const;
    oaBoolean               hasPin() const;
    oaPin                   *getPin() const;
    oaBoolean               hasNet() const;
    oaNet                   *getNet() const;

    oaShape                 *copy(const oaTransform &xform) const;
    oaShape                 *copy(const oaTransform &xform,
                                  oaDesign          *design) const;

    void                    release();

    enum {dtIndex = oacOccShapeDataType};
};



// *****************************************************************************
// oaOccArc
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccArc : public oaOccShape {
public:

    void                    getEllipseBBox(oaBox &bBox) const;
    oaDouble                getStartAngle() const;
    oaDouble                getStopAngle() const;
#if !defined(OA_DEPRECATED)
    void                    getEllipseBBox(oaBox &bBox);
    oaDouble                getStartAngle();
    oaDouble                getStopAngle();
#endif

    void                    getPoints(oaPointArray  &points,
                                      oaUInt4       numSegs = 10) const;
};



// *****************************************************************************
// oaOccDonut
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccDonut : public oaOccShape {
public:
    void                    getHoleBBox(oaBox &bBox) const;
    void                    getCenter(oaPoint &point) const;
    oaUInt4                 getRadius() const;
    oaUInt4                 getHoleRadius() const;
    void                    getBoundary(oaPointArray    &points,
                                        oaUInt4         numSides = 20) const;
};



// *****************************************************************************
// oaOccDot
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccDot : public oaOccShape {
public:
    void                    getLocation(oaPoint &point) const;
    oaUInt4                 getWidth() const;
    oaUInt4                 getHeight() const;
};



// *****************************************************************************
// oaOccEllipse
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccEllipse : public oaOccShape {
public:
    void                    getBoundary(oaPointArray    &points,
                                        oaUInt4         numSides) const;
};



// *****************************************************************************
// oaOccLine
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccLine : public oaOccShape {
public:
    oaUInt4                 getNumPoints() const;
    void                    getPoints(oaPointArray &points) const;
};



// *****************************************************************************
// oaOccPath
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccPath : public oaOccShape {
public:
    oaUInt4                 getWidth() const;
    oaUInt4                 getNumPoints() const;
    void                    getPoints(oaPointArray &points) const;
    oaPathStyle             getStyle() const;
    oaUInt4                 getBeginExt() const;
    oaUInt4                 getEndExt() const;
    void                    getBoundary(oaPointArray &boundary) const;
    oaBoolean               isOrthogonal() const;
};



// *****************************************************************************
// oaOccPathSeg
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccPathSeg : public oaOccShape {
public:
    void                    getPoints(oaPoint   &beginPoint,
                                      oaPoint   &endPoint) const;
    void                    getStyle(oaSegStyle &style) const;
    void                    getBoundary(oaPointArray &boundary) const;
    oaBoolean               isOrthogonal() const;
};



// *****************************************************************************
// oaOccPolygon
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccPolygon : public oaOccShape {
public:
    oaUInt4                 getNumPoints() const;
    void                    getPoints(oaPointArray &points) const;
    oaBoolean               isOrthogonal() const;
};



// *****************************************************************************
// oaOccRect
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccRect : public oaOccShape {
};



// *****************************************************************************
// oaOccText
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccText : public oaOccShape {
public:
    void                    getOrigin(oaPoint &origin) const;
    void                    getText(oaString &text) const;
    oaTextAlign             getAlignment() const;
    oaOrient                getOrient() const;
    oaFont                  getFont() const;
    oaUInt4                 getHeight() const;
    oaBoolean               hasOverbar() const;
    oaBoolean               isVisible() const;
    oaBoolean               isDrafting() const;
};



// *****************************************************************************
// oaOccEvalText
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccEvalText : public oaOccText {
public:
    void                    getExpression(oaString &text) const;
};



// *****************************************************************************
// oaOccTextDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccTextDisplay : public oaOccShape {
public:
    void                    getOrigin(oaPoint &origin) const;
    oaTextAlign             getAlignment() const;
    oaOrient                getOrient() const;
    oaFont                  getFont() const;
    oaUInt4                 getHeight() const;
    oaTextDisplayFormat     getFormat() const;
    oaBoolean               hasOverbar() const;
    oaBoolean               isVisible() const;
    oaBoolean               isDrafting() const;
    void                    getText(oaString &text) const;
};



// *****************************************************************************
// oaOccPropDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccPropDisplay : public oaOccTextDisplay {
public:
    oaProp                  *getProp() const;
};



// *****************************************************************************
// oaOccAttrDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccAttrDisplay : public oaOccTextDisplay {
public:
    void                    getText(const oaNameSpace   &ns,
                                    oaString            &text) const;
    oaObject                *getObject() const;
    oaAttrType              getAttribute() const;
};



// *****************************************************************************
// oaOccTextOverride
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccTextOverride : public oaOccTextDisplay {
public:
    oaText                  *getMasterText() const;
    void                    getMasterTextText(oaString &text) const;
    oaInst                  *getInst() const;
    oaBoolean               isBound() const;
};



// *****************************************************************************
// oaOccInstPropDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccInstPropDisplay : public oaOccTextDisplay {
public:
    oaProp                  *getMasterProp() const;
    oaInst                  *getInst() const;
    oaBoolean               isBound() const;
};



// *****************************************************************************
// oaOccInstAttrDisplay
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccInstAttrDisplay : public oaOccTextDisplay {
public:
    void                    getText(const oaNameSpace   &ns,
                                    oaString            &text) const;
    oaInst                  *getInst() const;
    oaDesignAttrType        getMasterAttribute() const;
    oaBoolean               isBound() const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccShape> {
public:
    typedef oaBlockObject   parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacOccShapeType};
};

template<>
class oaTraits<oaOccArc> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccArcType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccDonut> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccDonutType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccDot> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccDotType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccEllipse> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccEllipseType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccLine> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccLineType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccPath> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccPathType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccPathSeg> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccPathSegType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccPolygon> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccPolygonType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccRect> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccRectType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccText> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccTextType};
    enum {abstractTypeEnumVal = oacAbstractOccTextType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccEvalText> {
public:
    typedef oaOccText       parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccEvalTextType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccTextDisplay> {
public:
    typedef oaOccShape      parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacOccTextDisplayType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccPropDisplay> {
public:
    typedef oaOccTextDisplay    parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccPropDisplayType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccAttrDisplay> {
public:
    typedef oaOccTextDisplay    parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccAttrDisplayType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccTextOverride> {
public:
    typedef oaOccTextDisplay    parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccTextOverrideType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccInstPropDisplay> {
public:
    typedef oaOccTextDisplay    parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccInstPropDisplayType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};

template<>
class oaTraits<oaOccInstAttrDisplay> {
public:
    typedef oaOccTextDisplay    parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccInstAttrDisplayType};
    enum {dataTypeEnumVal = oacOccShapeDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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