oaDMCollection.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMCollection.h
//
// This file contains the definitions for collections and iterators and their
// supporting classes used in DM module which must be specialized.
//
// *****************************************************************************
// 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(oaDMCollection_P)
#define oaDMCollection_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseCollection.h"
#include "oaLib.h"



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



// *****************************************************************************
// oaCollection<oaLib, oaLib>
//
// These are the specialized open library db collection definition and its
// methods.
// *****************************************************************************
template<>
class OA_DM_DLL_API oaCollection<oaLib, oaLib> : public oaDatabaseCollection {
public:
                            oaCollection(oaUInt4 dbIDIn);
                            oaCollection(const oaCollection<oaLib, oaLib> &c);

    oaBoolean               includes(const oaLib *db) const;
};



// *****************************************************************************
// oaIter<oaLib>
//
// This is the specialization of oaIter<> for oaLib.
// *****************************************************************************
template <>
class OA_DM_DLL_API oaIter<oaLib> : public oaDatabaseIter {
public:
                            oaIter(const oaCollection<oaLib, oaLib> &c);
                            oaIter(const oaIter<oaLib> &iterIn);

    oaLib                   *getNext();
};



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



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



// *****************************************************************************
// oaCollection<oaDMData, oaDMData>
//
// These are the specialized open library db collection definition and its
// methods.
// *****************************************************************************
template<>
class OA_DM_DLL_API oaCollection<oaDMData, oaDMData> : public oaDatabaseCollection {
public:
                            oaCollection(oaUInt4 dbIDIn);
                            oaCollection(const oaCollection<oaDMData, oaDMData> &c);

    oaBoolean               includes(const oaDMData *db) const;
};



// *****************************************************************************
// oaIter<oaDMData>
//
// This is the specialization of oaIter<> for oaDMData.
// *****************************************************************************
template <>
class OA_DM_DLL_API oaIter<oaDMData> : public oaDatabaseIter {
public:
                            oaIter(const oaCollection<oaDMData, oaDMData> &c);
                            oaIter(const oaIter<oaDMData> &iterIn);

    oaDMData                *getNext();
};



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



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



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



END_OA_NAMESPACE

#endif

Return to top of page

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