oaGroupDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaGroupDef.h
//
// This file contains the definitions for the following classes:
//      oaGroupDef
//
// *****************************************************************************
// 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 2006 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaGroupDef_P)
#define oaGroupDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseModTypes.h"
#include "oaArray.h"
#include "oaSessionObject.h"



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



// *****************************************************************************
// oaGroupPurposeTypeEnum
// *****************************************************************************
#define oavNumGroupPurposeTypes 6

enum oaGroupPurposeTypeEnum {
    oacUnrestrictedGroupPurposeType = 0,
    oacDiffNetPairGroupPurposeType  = 1,
    oacMatchedNetGroupPurposeType   = 2,
    oacNetGroupPurposeType          = 3,
    oacNestedNetGroupPurposeType    = 4,
    oacSymmetricNetGroupPurposeType = 5
};



// *****************************************************************************
// oaGroupPurposeType
// *****************************************************************************
class OA_BASE_DLL_API oaGroupPurposeType {
public:
                            oaGroupPurposeType(oaGroupPurposeTypeEnum valueIn);
                            oaGroupPurposeType(const oaString &name);

    const oaString          &getName() const;
                            operator                oaGroupPurposeTypeEnum() const;

private:
    static const oaString   *initNames();

    oaGroupPurposeTypeEnum  value;
};



// *****************************************************************************
// oaGroupDef
// *****************************************************************************
class OA_BASE_DLL_API oaGroupDef : public oaSessionObject {
public:
    static oaGroupDef       *find(const oaString &name);

    static oaGroupDef       *get(oaGroupPurposeType groupDefType);
    void                    getName(oaString &name) const;
    void                    getValidTypes(oaManagedTypeArray &validTypes) const;
    void                    getValidDatabases(oaSubset<oaDBType> &validDatabases) const;
    oaBoolean               isBuiltIn() const;

    void                    destroy();
    void                    remove(oaObject *database);

    enum {dtIndex = oacBaseGroupDefDataType};
};



// *****************************************************************************
// oaGroupDefArray
// *****************************************************************************
class OA_BASE_DLL_API oaGroupDefArray : public oaSubset<oaGroupDef*> {
};



// *****************************************************************************
// oaFlatGroupDef
// *****************************************************************************
class OA_BASE_DLL_API oaFlatGroupDef : public oaGroupDef {
public:
    static oaFlatGroupDef   *create(const oaString              &name,
                                    const oaManagedTypeArray    &validTypes,
                                    const oaSubset<oaDBType>    &validDatabases);
};



// *****************************************************************************
// oaHierGroupDef
// *****************************************************************************
class OA_BASE_DLL_API oaHierGroupDef : public oaGroupDef {
public:
    static oaHierGroupDef   *create(const oaString              &name,
                                    const oaManagedTypeArray    &validTypes,
                                    const oaSubset<oaDBType>    &validDatabases);
    static oaHierGroupDef   *create(const oaString              &name,
                                    const oaManagedTypeArray    &validTypes,
                                    const oaSubset<oaDBType>    &validDatabases,
                                    const oaGroupDefArray       &validGroupTypes,
                                    oaBoolean                   recursive = false);

    oaBoolean               isRecursive() const;
    void                    getValidGroupTypes(oaGroupDefArray &validGroupTypes) const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaGroupDef> {
public:
    typedef oaSessionObject         parentType;
    typedef oaObjectDefModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseGroupDefDataType};
    enum {abstractTypeEnumVal = oacGroupDefType};
    enum {objectTypeEnumVal = oacFlatGroupDefType};
    enum {dataTypeEnumVal = oacBaseGroupDefDataType};
};

template<>
class oaTraits<oaFlatGroupDef> {
public:
    typedef oaGroupDef              parentType;
    typedef oaObjectDefModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacFlatGroupDefType};
    enum {dataTypeEnumVal = oacBaseGroupDefDataType};
};

template<>
class oaTraits<oaHierGroupDef> {
public:
    typedef oaGroupDef              parentType;
    typedef oaObjectDefModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacHierGroupDefType};
    enum {dataTypeEnumVal = oacBaseGroupDefDataType};
};



// *****************************************************************************
// Explicit template instantiations
// *****************************************************************************
#if defined(OA_BASE_DLL_EXTERN)
OA_BASE_DLL_EXTERN template
 class OA_BASE_DLL_API oaArray<oaGroupDef*>;

#endif



END_OA_NAMESPACE

#endif

Return to top of page

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