oaConnCollection.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaConnCollection.h
//
// This file contains the definitions for collections and iterators and their
// supporting classes used in conn 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 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaConnCollection_P)
#define oaConnCollection_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaObject.h"
#include "oaDesignDBTypes.h"



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



// *****************************************************************************
// Forward class declaration
// *****************************************************************************
class oaDatabase;



// *****************************************************************************
// oaNetNetCollTypeEnum
// *****************************************************************************
enum oaNetNetCollTypeEnum {
    oacSingleBitMemNetCollType  = 1,
    oacBundleMemNetCollType     = 2,
    oacEquivNetCollType         = 3,
    oacGlobalNetCollType        = 4,
    oacSpanNetCollType          = 5
};



// *****************************************************************************
// oaTermTermCollTypeEnum
// *****************************************************************************
enum oaTermTermCollTypeEnum {
    oacBundleMemTermCollType    = 1,
    oacMustJoinTermCollType     = 2
};



// *****************************************************************************
// oaBaseMemNetCollection
//
// This is the base collection for the memNet collections.
// *****************************************************************************
class OA_DESIGN_DLL_API oaBaseMemNetCollection {
public:
                            oaBaseMemNetCollection(oaDatabase   *db,
                                                   oaObject     *objIn,
                                                   oaUInt4      flag = 0);

    oaUInt4                 getCount();
    oaBoolean               isEmpty();
    oaBoolean               includes(const oaObject *objectIn);

protected:
    oaObject                *object;
    oaDatabase              *database;
    oaDomain                domain;
    oaUInt4                 flag;

    friend class oaBaseMemNetIter;
};



// *****************************************************************************
// oaMemNetCollection
// *****************************************************************************
class OA_DESIGN_DLL_API oaMemNetCollection : public oaBaseMemNetCollection {
public:
                            oaMemNetCollection(oaDatabase   *db,
                                               oaObject     *objIn,
                                               oaUInt4      flag = 0);

    oaBoolean               includes(const oaNet *objectIn);
};



// *****************************************************************************
// oaOccMemNetCollection
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccMemNetCollection : public oaBaseMemNetCollection {
public:
                            oaOccMemNetCollection(oaDatabase    *db,
                                                  oaObject      *objIn,
                                                  oaUInt4       flag = 0);

    oaBoolean               includes(const oaOccNet *object);
};



// *****************************************************************************
// oaModMemNetCollection
// *****************************************************************************
class OA_DESIGN_DLL_API oaModMemNetCollection : public oaBaseMemNetCollection {
public:
                            oaModMemNetCollection(oaDatabase    *db,
                                                  oaObject      *objIn,
                                                  oaUInt4       flag = 0);

    oaBoolean               includes(const oaModNet *object);
};



// *****************************************************************************
// oaBaseMemNetIter
// *****************************************************************************
class OA_DESIGN_DLL_API oaBaseMemNetIter {
public:
                            oaBaseMemNetIter(const oaBaseMemNetCollection &cl);
                            oaBaseMemNetIter(const oaBaseMemNetIter &iterIn);

    oaObject                *getNext(oaUInt4 &arg);
    void                    reset();

protected:
    void                    findNextBundle(oaUInt4  &index,
                                           oaUInt4  &member);

    oaNetTbl                *tbl;
    oaBusNetDefTbl          *dTbl;
    oaDomain                domain;
    oaUInt4                 index;

    oaUInt4                 curNetIndex;
    oaUInt4                 bunNetIndex;
    oaUInt4                 bunMem;
    oaUInt4                 bitInMem;
    oaUInt4                 findNetIndex;
    oaUInt4                 busDefIndex;
    oaUInt4                 busNetIndex;
    oaUInt4                 busBit;
    oaBoolean               uniqueOnly;

private:
    void                    resetIter();

    oaBoolean               isOccNetIter() const;
    oaNetTbl                *getNetTbl() const;

    oaObject                *getObject(oaUInt4  index,
                                       oaDomain domain);
    oaObject                *getDomainObject(oaUInt4    index,
                                             oaDomain   domain);

    enum oaMemNetState {
        oacMemNetSelf   = 0,
        oacMemNetBundle = 1,
        oacMemNetBus    = 2
    };

    oaMemNetState           iterState;
};



// *****************************************************************************
// oaMemNetIter
// *****************************************************************************
class OA_DESIGN_DLL_API oaMemNetIter : public oaBaseMemNetIter {
public:
                            oaMemNetIter(const oaMemNetCollection &cl);
                            oaMemNetIter(const oaMemNetIter &iterIn);

    oaNet                   *getNext(oaUInt4 &arg);
};



// *****************************************************************************
// oaModMemNetIter
// *****************************************************************************
class OA_DESIGN_DLL_API oaModMemNetIter : public oaBaseMemNetIter {
public:
                            oaModMemNetIter(const oaModMemNetCollection &cl);
                            oaModMemNetIter(const oaModMemNetIter &iterIn);

    oaModNet                *getNext(oaUInt4 &arg);
};



// *****************************************************************************
// oaOccMemNetIter
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccMemNetIter : public oaBaseMemNetIter {
public:
                            oaOccMemNetIter(const oaOccMemNetCollection &cl);
                            oaOccMemNetIter(const oaOccMemNetIter &iterIn);

    oaOccNet                *getNext(oaUInt4 &arg);
};



END_OA_NAMESPACE

#endif

Return to top of page

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