oaDesignCollection.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDesignCollection.h
//
// This file contains the definitions for collections and iterators and their
// supporting classes used in oaDesign module.
//
// *****************************************************************************
// 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(oaDesignCollection_P)
#define oaDesignCollection_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseCollection.h"
#include "oaDesignDBTypes.h"
#include "oaDesignObject.h"



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



// *****************************************************************************
// Control bits for the net iterators
// *****************************************************************************
#define oacNetIterAll                   0x0001u
#define oacNetIterSingleBit             0x0002u
#define oacNetIterBundle                0x0004u
#define oacNetIterPreferred             0x0010u
#define oacNetIterNotImplicit           0x0020u
#define oacNetIterGlobal                0x0040u
#define oacNetIterMask                  0x007fu



// *****************************************************************************
// Control bits for the bitNet iterators
// *****************************************************************************
#define oacEquivalentNetIterAll         0x0001u
#define oacEquivalentNetIterExplicit    0x0002u
#define oacEquivalentNetIterImplicit    0x0004u



// *****************************************************************************
// Control bits for the terminal iterators
// *****************************************************************************
#define oacTermIterAllNotHidden         0x0001u
#define oacTermIterSingleBit            0x0002u
#define oacTermIterBundle               0x0004u
#define oacTermIterNotImplicit          0x0010u
#define oacTermIterAll                  0x0020u
#define oacTermIterMask                 0x003fu


#define oacTermIterEquivNets            0x0100u


// *****************************************************************************
// Control bits for the bus terminal iterators
// *****************************************************************************
#define oacBusTermIterAll               0x0001u
#define oacBusTermIterAllNotHidden      0x0002u
#define oacBusTermIterMask              0x0003u



// *****************************************************************************
// Control bits for the busTermBit iterators
// *****************************************************************************
#define oacBusTermBitIterAll            0x0001u
#define oacBusTermBitIterAllNotHidden   0x0002u
#define oacBusTermBitIterMask           0x0003u



// *****************************************************************************
// Control bits for the instance iterators
// *****************************************************************************
#define oacInstIterAll                  0x0000u
#define oacInstIterSingleBit            0x0001u
#define oacInstIterNotImplicit          0x0002u
#define oacInstIterMask                 0x0003u



// *****************************************************************************
// Control bits for the instTerm iterators
// *****************************************************************************
#define oacInstTermIterAllNotHidden     0x0000u
#define oacInstTermIterSingleBit        0x0001u
#define oacInstTermIterNotImplicit      0x0002u
#define oacInstTermIterAll              0x0010u
#define oacInstTermIterMask             0x0013u
#define oacInstTermIterEquivNets        0x0004u



// *****************************************************************************
// Control bits for the shape iterators
// *****************************************************************************
#define oacShapeIterNetOnly             0x0000u
#define oacShapeIterNetRoutes           0x0001u
#define oacShapeIterNetPins             0x0002u



// *****************************************************************************
// Control bits for the guide iterators
// *****************************************************************************
#define oacGuideIterBeginLayer          0x0001u
#define oacGuideIterEndLayer            0x0002u
#define oacGuideIterBeginAndEndLayers   0x0003u



// *****************************************************************************
// Control bits for the via iterators
// *****************************************************************************
#define oacViaIterNetOnly               0x0000u
#define oacViaIterNetRoutes             0x0001u
#define oacViaIterNetPins               0x0002u



// *****************************************************************************
// Control bits for the occ object iterators
// *****************************************************************************
#define oavOccIterCrossDesign           0x0001u



// *****************************************************************************
// Control bits for the node iterators
// *****************************************************************************
#define oavNodeIterConnNodes            0x0001u



// *****************************************************************************
// Constant definitions and declarations
// *****************************************************************************
#define oavDesignObjectIterDataSize     16

struct oaDesignObjectIterData;



// *****************************************************************************
// oaDesignCollTypeEnum
// *****************************************************************************
enum oaDesignCollTypeEnum {
    oacBaseDesignCollType       = 0,
    oacSubMasterDesignCollType  = 1
};



// *****************************************************************************
// oaDesignIterTypeEnum
// *****************************************************************************
enum oaDesignIterTypeEnum {
    oacBaseDesignIterType       = 0,
    oacSubMasterDesignIterType  = 1
};



// *****************************************************************************
// oaDesignCollection
//
// This is oaDesign collection and the specialized collection which derives 
// from it.
// *****************************************************************************
class OA_DESIGN_DLL_API oaDesignCollection : public oaDatabaseCollection {
public:
                            oaDesignCollection(oaUInt4              dbIDIn,
                                               oaDesignCollTypeEnum tIn,
                                               const oaDesign       *design = NULL);
                            oaDesignCollection(const oaDesignCollection &c);

    oaUInt4                 getCount() const;
    oaBoolean               isEmpty() const;
    oaBoolean               includes(const oaDesign *design) const;

private:
    void                    *database;
    oaDesignCollTypeEnum    type;

    friend class oaDesignIter;
};



// *****************************************************************************
// oaCollection<oaDesign, oaDesign>
//
// This is the specialized design collection.
// *****************************************************************************
template<>
class OA_DESIGN_DLL_API oaCollection<oaDesign, oaDesign> : public oaDesignCollection {
public:
                            oaCollection(oaUInt4                dbIDIn,
                                         oaDesignCollTypeEnum   tIn = oacBaseDesignCollType,
                                         const oaDesign         *design = NULL);
                            oaCollection(const oaCollection<oaDesign, oaDesign> &c);

    friend class oaIter<oaDesign>;
};



// *****************************************************************************
// oaDesignIter
//
// This is design iterator and the specialized iterator which derives from
// it.
// *****************************************************************************
class OA_DESIGN_DLL_API oaDesignIter : public oaDatabaseIter {
public:
                            oaDesignIter(const oaDesignCollection &c);
                            oaDesignIter(const oaDesignIter &iterIn);

    oaDesign                *getNext();
    void                    reset();

private:
    void                    *superMaster;
    void                    *next;
    oaDesignIterTypeEnum    type;
};



// *****************************************************************************
// oaIter<oaDesign>
//
// This is design iterator and the specialized iterator which derives from
// it.
// *****************************************************************************
template<>
class OA_DESIGN_DLL_API oaIter<oaDesign> : public oaDesignIter {
public:
                            oaIter(const oaCollection<oaDesign, oaDesign> &c);
                            oaIter(const oaIter<oaDesign> &iterIn);
};



// *****************************************************************************
// oaCollection<oaDesignObject, oaNode>
//
// These are the definitions of a specialized oaIter<> class and its methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaDesignObject, oaNode> {
public:
                            oaCollection(const oaNode *node);
                            oaCollection(const oaCollection<oaDesignObject, oaNode> &c);

    oaUInt4                 getCount() const;
    oaBoolean               isEmpty() const;
    oaBoolean               includes(const oaDesignObject *object) const;

    const oaNode            *object;
};



// *****************************************************************************
// oaCollection<oaDesignObject, oaParasiticNetwork>
//
// These are the definitions of a specialized oaIter<> class and its methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaDesignObject, oaParasiticNetwork> {
public:
                                oaCollection(const oaParasiticNetwork *nw);
                                oaCollection(const oaCollection<oaDesignObject, oaParasiticNetwork> &c);

    oaUInt4                     getCount() const;
    oaBoolean                   isEmpty() const;
    oaBoolean                   includes(const oaDesignObject *object) const;

    const oaParasiticNetwork    *object;
};



// *****************************************************************************
// oaDesignObjectIter
// 
// This is the base class for oaIter<oaDesignObject>.
// *****************************************************************************
class OA_DESIGN_DLL_API oaDesignObjectIter {
public:
                            oaDesignObjectIter(const oaCollection<oaDesignObject, oaNode> &c);
                            oaDesignObjectIter(const oaCollection<oaDesignObject, oaParasiticNetwork> &c);
                            oaDesignObjectIter(const oaDesignObjectIter &iter);
                        
    oaDesignObject          *getNext();
    void                    reset();

private:
    enum oaDesignObjIterTypeEnum {
        oacNodeConnIterType     = 0,
        oacCoupledNetIterType   = 1
    };

    void                    *tbl;
    oaDomain                domain;
    oaDesignObjIterTypeEnum type;
    oaUInt4                 index;
    oaUInt4                 ownerIndex;
};



// *****************************************************************************
// oaIter<oaDesignObject>
//
// These are the specialized definitions of an oaIter<> class and its methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaIter<oaDesignObject> : public oaDesignObjectIter {
public:
                            oaIter(const oaCollection<oaDesignObject, oaNode> &c);
                            oaIter(const oaCollection<oaDesignObject, oaParasiticNetwork> &c);
                            oaIter(const oaIter<oaDesignObject> &iter);
};



// *****************************************************************************
// oaCollection<oaAppDef, oaDesign>
//
// These are the specialized definitions of an oaCollection<> class and its 
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaAppDef, oaDesign> : public oaCollection<oaAppDef, oaObject> {
public:
                            oaCollection(const oaObject     *db,
                                         oaDesignDataType   dataType,
                                         oaDomain           domain);
                            oaCollection(const oaCollection<oaAppDef, oaDesign> &c);
};



// *****************************************************************************
// oaCollection<oaAppObject, oaDesign>
//
// These are the specialized definitions of an oaCollection<> class and its 
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaAppObject, oaDesign> : public oaAppObjectCollection {
public:
                            oaCollection(const oaObject         *db,
                                         const oaAppObjectDef   *def);
                            oaCollection(const oaCollection<oaAppObject, oaDesign> &c);
};



// *****************************************************************************
// oaCollection<oaAppObjectDef, oaDesign>
//
// These are the specialized definitions of an oaCollection<> class and its 
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaAppObjectDef, oaDesign> : public oaAppObjectDefCollection {
public:
                            oaCollection(const oaObject *db);
                            oaCollection(const oaCollection<oaAppObjectDef, oaDesign> &c);
};



// *****************************************************************************
// oaCollection<oaGroup, oaDesign>
//
// These are the specialized definitions of an oaCollection<> class and its 
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaGroup, oaDesign> : public oaGroupCollection {
public:
                            oaCollection(const oaObject *db,
                                         oaUInt4        domainFlagsIn,
                                         oaUInt4        nameIndexIn = oacNullIndex);
                            oaCollection(const oaCollection<oaGroup, oaDesign> &c);
};



// *****************************************************************************
// oaCollection<oaConstraint, oaDesign>
//
// These are the specialized definitions of an oaCollection<> class and its 
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaConstraint, oaDesign> : public oaConstraintCollection {
public:
                            oaCollection(const oaObject *db);
                            oaCollection(const oaObject *db,
                                         oaUInt4        defIndexIn);
                            oaCollection(const oaCollection<oaConstraint, oaDesign> &c);
};



END_OA_NAMESPACE

#endif

Return to top of page

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