oaConstraintGroupDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaConstraintGroupDef.h
//
// This file contains the definitions for the following classes:
//      oaConstraintGroupDef
//
// *****************************************************************************
// 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: dell $
//  $Revision: #1 $
//  $Date: 2006/12/20 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaConstraintGroupDef_P)
#define oaConstraintGroupDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCommonTypes.h"
#include "oaBaseTypes.h"
#include "oaBaseModTypes.h"
#include "oaString.h"
#include "oaType.h"
#include "oaArray.h"
#include "oaDomain.h"
#include "oaObject.h"
#include "oaSessionObject.h"



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



// *****************************************************************************
// oaConstraintGroupTypeEnum
// *****************************************************************************
#define oavNumConstraintGroupTypes      11

enum oaConstraintGroupTypeEnum {
    oacUserDefinedConstraintGroupType       = 0,
    oacImplicitConstraintGroupType          = 1,
    oacDefaultConstraintGroupType           = 2,
    oacFoundryConstraintGroupType           = 3,
    oacTaperConstraintGroupType             = 4,
    oacInputTaperConstraintGroupType        = 5,
    oacOutputTaperConstraintGroupType       = 6,
    oacShieldingConstraintGroupType         = 7,
    oacTransReflexiveConstraintGroupType    = 8,
    oacReflexiveConstraintGroupType         = 9,
    oacInterChildConstraintGroupType        = 10
};



// *****************************************************************************
// oaConstraintGroupType
// *****************************************************************************
class OA_BASE_DLL_API oaConstraintGroupType {
public:
                                oaConstraintGroupType(oaConstraintGroupTypeEnum valueIn);
                                oaConstraintGroupType(const oaString &name);
                                ~oaConstraintGroupType();

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

private:
    static const oaString       *initNames();

    oaConstraintGroupTypeEnum   value;
};



// *****************************************************************************
// oaConstraintGroupDef
// *****************************************************************************
class OA_BASE_DLL_API oaConstraintGroupDef : public oaSessionObject {
public:
    static oaConstraintGroupDef *create(const oaString              &name,
                                        const oaManagedTypeArray    &allowedOwners,
                                        const oaSubset<oaDBType>    &allowedDatabases,
                                        oaBoolean                   uniqueInDatabase = false);
    static oaConstraintGroupDef *find(const oaString &name);
    static oaConstraintGroupDef *get(oaConstraintGroupType type);

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

    void                        getName(oaString &name) const;
    oaConstraintGroupType       getConstraintGroupType() const;
    oaBoolean                   isBuiltIn() const;
    oaBoolean                   isUniqueInDB() const;
    void                        getAllowedOwners(oaManagedTypeArray &allowedOwners) const;
    void                        getAllowedDatabases(oaSubset<oaDBType> &allowedDatabases) const;

    enum {dtIndex = oacBaseConstraintGroupDefDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaConstraintGroupDef> {
public:
    typedef oaSessionObject         parentType;
    typedef oaObjectDefModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseConstraintGroupDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacConstraintGroupDefType};
    enum {dataTypeEnumVal = oacBaseConstraintGroupDefDataType};
};

END_OA_NAMESPACE

#endif

Return to top of page

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