oaConstraintGroup.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaConstraintGroup.h
//
// This file contains the definitions for the oaConstraintGroup and
// oaConstraintGroupMem classes.
//
// The oaConstraintGroup class implements an ordered collection of constraints
// and constraintGroup objects. A number of automatic constraint groups are
// supported in the different types of databases:
//
// - Every object that can have constraints has an implicit constraint group
//   that is returned by oaObject::getConstraintGroup.
// - The oaTech, oaModule, oaDesign, oaBoundary, and oaBlock classes support
//   a built-in default constraint group that is returned by the
//   getDefaultConstraintGroup function on that object.
// - The oaTech class supports a foundry constraint group that is returned by
//   oaTech::getFoundryRules.
//
// All constraint groups have a unique name within a database.
//
// Constraint groups can be created in the design, technology, and wafer
// databases.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaConstraintGroup_P)
#define oaConstraintGroup_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCollection.h"
#include "oaBaseCollection.h"
#include "oaConstraint.h"



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



// *****************************************************************************
// oaConstraintGroupOperatorEnum
// *****************************************************************************
#define oavNumConstraintGroupOperators  3

enum oaConstraintGroupOperatorEnum {
    oacPrecedenceGroupOperator  = 0,
    oacAndGroupOperator         = 1,
    oacOrGroupOperator          = 2
};



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

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

private:
    static const oaString           *initNames();

    oaConstraintGroupOperatorEnum   value;
};


// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaConstraintGroupDef;
class oaConstraintGroupMem;
class oaConstraintGroup;
class oaConstraint;
class oaConstraintDef;



// *****************************************************************************
// oaConstraintGroup
// *****************************************************************************
class OA_BASE_DLL_API oaConstraintGroup : public oaObject {
public:
    static oaConstraintGroup                                *create(oaObject        *database,
                                                                    const oaString  &name,
                                                                    oaBoolean       override = false);
    static oaConstraintGroup                                *create(oaObject                    *database,
                                                                    const oaString              &name,
                                                                    oaBoolean                   override,
                                                                    oaConstraintGroupOperator   op);
    static oaConstraintGroup                                *create(oaObject                    *database,
                                                                    oaConstraintGroupDef        *def,
                                                                    const oaString              &name,
                                                                    oaBoolean                   override = false,
                                                                    oaConstraintGroupOperator   op = oacPrecedenceGroupOperator);
    static oaConstraintGroup                                *create(oaConstraintGroupDef        *def,
                                                                    oaObject                    *object,
                                                                    oaBoolean                   override = false,
                                                                    oaConstraintGroupOperator   op = oacPrecedenceGroupOperator);

    static oaConstraintGroup                                *find(const oaObject    *database,
                                                                  const oaString    &name);
    static oaConstraintGroup                                *find(const oaObject    *database,
                                                                  const oaString    &name,
                                                                  oaBoolean         local);

    static oaConstraintGroup                                *find(const oaConstraintGroupDef    *def,
                                                                  const oaObject                *object);

    oaConstraintGroupDef                                    *getDef() const;
    oaConstraintGroupOperator                               getOperator() const;

    void                                                    destroy();

    oaBoolean                                               override() const;
    void                                                    getName(oaString &name) const;

    oaObject                                                *getOwner() const;

    oaCollection<oaConstraintGroupMem, oaConstraintGroup>   getMembers() const;
    oaCollection<oaConstraint, oaConstraintGroup>           getConstraints(const oaConstraintDef *def = NULL) const;

    enum {dtIndex = oacBaseConstraintGroupDataType};
};



// *****************************************************************************
// oaConstraintGroupMem
// *****************************************************************************
class OA_BASE_DLL_API oaConstraintGroupMem : public oaObject {
public:
    static oaConstraintGroupMem *create(oaConstraintGroup   *group,
                                        oaConstraint        *constraint,
                                        oaBoolean           prepend = false);
    static oaConstraintGroupMem *create(oaConstraintGroup   *group,
                                        oaConstraintGroup   *groupMem,
                                        oaBoolean           prepend = false);

    void                        destroy();

    oaConstraintGroup           *getConstraintGroup() const;
    oaObject                    *getObject() const;

    oaBoolean                   isImplicit() const;

    void                        moveAfter(oaConstraintGroupMem *member);
    void                        moveToFirst();

    enum {dtIndex = oacBaseConstraintGroupMemDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaConstraintGroup> {
public:
    typedef oaObject                        parentType;
    typedef oaConstraintGroupModTypeEnum    modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseConstraintGroupDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacConstraintGroupType};
    enum {dataTypeEnumVal = oacBaseConstraintGroupDataType};
};

template<>
class oaTraits<oaConstraintGroupMem> {
public:
    typedef oaObject                        parentType;
    typedef oaConstraintGroupMemModTypeEnum modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseConstraintGroupMemDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacConstraintGroupMemType};
    enum {dataTypeEnumVal = oacBaseConstraintGroupMemDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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