oaFig.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaFig.h
//
// This file contains the definition for the oaFig, oaRouteStatus, and
// oaRouteTopology classes. 
//
//  oaFig
//      The oaFig class is an abstract class that is the base for all OpenAccess
//      database figures (connFigs, blockages, boundaries, rows and markers.)
//
//  oaConnFig
//      The oaConnFig class is an abstract class that is the base for all
//      OpenAccess database figures that can represent connectivity. (pinFigs,
//      routes and guides)
//
//  oaPinFig
//      The oaPinFig class is an abstract class that is the base for all
//      OpenAccess database figures that can represent pins. (shapes, vias and
//      insts)
//
//  oaRouteStatus
//      The oaRouteStatus class implements an enumerated type that describes the
//      routing status of a net that is associated with either a route, shape or
//      via.
//
//  oaRouteTopology
//      The oaRouteTopology class implements an enumerated type that describes
//      the topology of a net that is associated with either a route, via or a
//      pathSeg shape.
//
// *****************************************************************************
// 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(oaFig_P)
#define oaFig_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBox.h"
#include "oaTransform.h"
#include "oaBlockObject.h"



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



// *****************************************************************************
// oaRouteStatusEnum
// *****************************************************************************
#define oavNumRouteStatusTypes  3

enum oaRouteStatusEnum {
    oacNormalRouteStatus    = 0,
    oacFixedRouteStatus     = 1,
    oacLockedRouteStatus    = 2
};



// *****************************************************************************
// oaRouteStatus
// *****************************************************************************
class OA_DESIGN_DLL_API oaRouteStatus {
public:         
                            oaRouteStatus(oaRouteStatusEnum valueIn);
                            oaRouteStatus(const oaString &name);
                            ~oaRouteStatus();

    const oaString          &getName() const;

                            operator                oaRouteStatusEnum() const;

private:
    oaRouteStatusEnum       value;

    static const oaString   names[];
};



// *****************************************************************************
// oaRouteTopologyEnum
// *****************************************************************************
#define oavNumRouteTopologyEnums    9

enum oaRouteTopologyEnum {
    oacNoneRouteTopology                = 0,
    oacStripeRouteTopology              = 1,
    oacStandardCellWireRouteTopology    = 2,
    oacIOWireRouteTopology              = 3,
    oacBlockWireRouteTopology           = 4,
    oacRingRouteTopology                = 5,
    oacPadRingRouteTopology             = 6,
    oacBlockRingRouteTopology           = 7,
    oacCoreWireRouteTopology            = 8
};



// *****************************************************************************
// oaRouteTopology
// *****************************************************************************
class OA_DESIGN_DLL_API oaRouteTopology {
public:
                            oaRouteTopology(oaRouteTopologyEnum valueIn);
                            oaRouteTopology(const oaString &name);
                            ~oaRouteTopology();

    const oaString          &getName() const;

                            operator                oaRouteTopologyEnum() const;

private:
    oaRouteTopologyEnum     value;

    static const oaString   names[];
};



// *****************************************************************************
// oaFig
// *****************************************************************************
class OA_DESIGN_DLL_API oaFig : public oaBlockObject {
public:
    void                    destroy();

    void                    getBBox(oaBox &bBox) const;
    oaFigGroupMem           *getFigGroupMem() const;

    oaBoolean               overlaps(const oaBox &box) const;

    void                    move(const oaTransform &xform);
    oaFig                   *move(const oaTransform &xform,
                                  oaBlock           *block);

    oaFig                   *copy(const oaTransform &xform) const;
    oaFig                   *copy(const oaTransform &xform,
                                  oaBlock           *block) const;

#if !defined(OA_DEPRECATED)
    oaFig                   *move(const oaTransform &xform,
                                  oaDesign          *design);
    oaFig                   *copy(const oaTransform &xform,
                                  oaDesign          *design) const;
#endif
};



// *****************************************************************************
// oaConnFig
// *****************************************************************************
class OA_DESIGN_DLL_API oaConnFig : public oaFig {
public:
    oaBoolean               hasNet() const;
    oaNet                   *getNet() const;

    void                    addToNet(oaNet *net);
    void                    removeFromNet();
};



// *****************************************************************************
// oaPinFig
// *****************************************************************************
class OA_DESIGN_DLL_API oaPinFig : public oaConnFig {
public:
    oaBoolean               hasPin() const;
    oaPin                   *getPin() const;

    void                    addToPin(oaPin *pin);
    void                    removeFromPin();
};



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

template<>
class oaTraits<oaConnFig> {
public:
    typedef oaFig           parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacConnFigType};
};

template<>
class oaTraits<oaPinFig> {
public:
    typedef oaConnFig       parentType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacPinFigType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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