oaPhysCollection.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPhysCollection.h
//
// This file contains the definitions for collections and iterators and their
// supporting classes used in phys 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: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPhysCollection_P)
#define oaPhysCollection_P



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



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



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



// *****************************************************************************
// oaCollection<oaBlockObject, oaMarker>
//
// These are the definitions of a specialized oaCollection<> class.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaBlockObject, oaMarker> {
public:
                            oaCollection(void *object);
                            oaCollection(const oaCollection<oaBlockObject, oaMarker> &c);

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

    void                    *object;
};



// *****************************************************************************
// oaBlockObjectIter
//
// This is the base class for oaIter<oaDesignObject>.
// *****************************************************************************
class OA_DESIGN_DLL_API oaBlockObjectIter {
public:
                            oaBlockObjectIter(const oaCollection<oaBlockObject, oaMarker> &c);
                            oaBlockObjectIter(const oaBlockObjectIter &iter);

    oaBlockObject           *getNext();
    void                    reset();

private:
    void                    *tbl;
    oaUInt4                 index;
    oaUInt4                 ownerIndex;
    oaUInt4                 ownerDataType;
};




// *****************************************************************************
// oaIter<oaBlockObject>
//
// These are the specialized definitions of an oaIter<> class.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaIter<oaBlockObject> : public oaBlockObjectIter {
public:
                            oaIter(const oaCollection<oaBlockObject, oaMarker> &c);
                            oaIter(const oaIter<oaBlockObject> &iter);
};



// *****************************************************************************
// oaCollection<oaMarker, oaBlockObject>
//
// These are the specialized definitions of an oaCollection<> class and its
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaMarker, oaBlockObject> {
public:
                            oaCollection(const oaObject *obj);
                            oaCollection(const oaCollection<oaMarker, oaBlockObject> &c);

    oaUInt4                 getCount() const;
    oaBoolean               isEmpty() const;
    oaBoolean               includes(const oaMarker *marker) const;

private:
    void                    *objTbl;
    oaUInt4                 objIndex;

    friend class oaIter<oaMarker>;
};



// *****************************************************************************
// oaIter<oaMarker>
//
// This is oaMarker specialization of oaIter<>.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaIter<oaMarker> {
public:
                            oaIter(const oaCollection<oaMarker, oaBlock> &c);
                            oaIter(const oaCollection<oaMarker, oaBlockObject> &c);
                            oaIter(const oaIter<oaMarker> &iterIn);

    oaMarker                *getNext();
    void                    reset();

private:
    struct oaMarkerIterData {
        oaMarkerMemTbl      *memTbl;
        oaUInt4             objType;
        oaUInt4             objIndex;
    };

    enum oaMarkerIterTypeEnum {
        oacDesignIterType   = 0,
        oacObjectIterType   = 1,
        oacEmptyIterType    = 2
    };


    oaMarkerIterData        *data() const;

    void                    *tbl;
    oaMarkerIterTypeEnum    type;
    oaUInt4                 i;
    oaByte                  dataP[oavMarkerIterDataSize];
};



// *****************************************************************************
// oaCollection<oaPinFig, oaPin>
//
// These are the specialized definitions of an oaCollection<> class and its
// methods.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaCollection<oaPinFig, oaPin> {
public:
                            oaCollection(const oaPin *pin);
                            oaCollection(const oaCollection<oaPinFig, oaPin> &c);

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

private:
    void                    *tbl;
    oaUInt4                 index;

    friend class oaIter<oaPinFig>;
};



// *****************************************************************************
// oaIter<oaPinFig>
//
// This is the oaPinFig specialization of oaIter<>.
// *****************************************************************************
template <>
class OA_DESIGN_DLL_API oaIter<oaPinFig> {
public:
                            oaIter(const oaCollection<oaPinFig, oaPin> &cl);
                            oaIter(const oaIter<oaPinFig> &iterIn);

    oaPinFig                *getNext();
    void                    reset();

private:
    void                    *tbl;
    oaUInt4                 index;
    oaUInt4                 eIndex;
};



END_OA_NAMESPACE

#endif

Return to top of page

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