oaGroup.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaGroup.h
//
// This file contains the definitions for the oaGroup and oaGroupMember classes.
//
// *****************************************************************************
// 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(oaGroup_P)
#define oaGroup_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseModTypes.h"
#include "oaObject.h"



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaGroupDef;



// *****************************************************************************
// Control Bits for the various group iterators
// *****************************************************************************
#define oacGroupIterNoDomain    0x0001u
#define oacGroupIterBlockDomain 0x0002u
#define oacGroupIterModDomain   0x0004u
#define oacGroupIterOccDomain   0x0008u



// *****************************************************************************
// oaGroupTypeEnum
// *****************************************************************************
#define oavNumGroupTypes    2

enum oaGroupTypeEnum {
    oacCollectionGroupType  = 0,
    oacSetGroupType         = 1
};



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

    const oaString          &getName() const;

                            operator                oaGroupTypeEnum() const;

private:
    oaGroupTypeEnum         value;

    static const oaString   names[];
};



// *****************************************************************************
// oaGroupDeleteWhenEnum
// *****************************************************************************
#define oavNumGroupDeleteWhenEnums  3

enum oaGroupDeleteWhenEnum {
    oacNeverGroupDeleteWhen     = 0,
    oacOnFirstGroupDeleteWhen   = 1,
    oacOnLastGroupDeleteWhen    = 2
};



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

    const oaString          &getName() const;

                            operator                oaGroupDeleteWhenEnum() const;

private:
    oaGroupDeleteWhenEnum   value;

    static const oaString   names[];
};



// *****************************************************************************
// oaGroup
// *****************************************************************************
class OA_BASE_DLL_API oaGroup : public oaObject {
public:
    static oaGroup                          *create(oaObject            *database,
                                                    const oaString      &name,
                                                    oaGroupType         groupType = oacSetGroupType,
                                                    oaBoolean           isUniqueName = true,
                                                    oaBoolean           isOrdered = false,
                                                    oaGroupDeleteWhen   deleteWhen = oacNeverGroupDeleteWhen);
    static oaGroup                          *create(oaObject            *database,
                                                    const oaString      &name,
                                                    oaDomain            domain,
                                                    oaGroupType         groupType = oacSetGroupType,
                                                    oaBoolean           isUniqueName = true,
                                                    oaBoolean           isOrdered = false,
                                                    oaGroupDeleteWhen   deleteWhen = oacNeverGroupDeleteWhen);
    static oaGroup                          *create(oaObject            *database,
                                                    const oaString      &name,
                                                    oaGroupDef          *groupDef,
                                                    oaGroupType         groupType = oacSetGroupType,
                                                    oaBoolean           isUniqueName = true,
                                                    oaBoolean           isOrdered = false,
                                                    oaGroupDeleteWhen   deleteWhen = oacNeverGroupDeleteWhen);
    static oaGroup                          *create(oaObject            *database,
                                                    const oaString      &name,
                                                    oaDomain            domain,
                                                    oaGroupDef          *groupDef,
                                                    oaGroupType         groupType = oacSetGroupType,
                                                    oaBoolean           isUniqueName = true,
                                                    oaBoolean           isOrdered = false,
                                                    oaGroupDeleteWhen   deleteWhen = oacNeverGroupDeleteWhen);

    void                                    destroy();

    void                                    getName(oaString &name) const;
    oaDomain                                getGroupDomain() const;
    oaGroupType                             getGroupType() const;
    oaGroupDeleteWhen                       getDeleteWhen() const;
    oaBoolean                               isUniqueName() const;
    oaBoolean                               isOrdered() const;
    oaBoolean                               isEmpty() const;

    void                                    setName(const oaString &name);
    void                                    setGroupType(oaGroupType type);
    void                                    setDeleteWhen(oaGroupDeleteWhen deleteWhen);
    void                                    setUniqueName(oaBoolean value);
    void                                    setOrdered(oaBoolean value);
    void                                    setLeader(oaGroupMember *leader = NULL);

    oaBoolean                               hasDefaultConstraintGroup() const;
    oaConstraintGroup                       *getDefaultConstraintGroup() const;

    oaObject                                *getOwner();
    oaGroupMember                           *getLeader();
    oaGroupDef                              *getDef() const;

    oaCollection<oaGroupMember, oaGroup>    getMembers() const;

    enum {dtIndex = oacBaseGroupDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// oaGroupMember
// *****************************************************************************
class OA_BASE_DLL_API oaGroupMember : public oaObject {
public:
    static oaGroupMember    *create(oaGroup     *group,
                                    oaObject    *object,
                                    oaBoolean   isLeader = false);

    void                    destroy();

    oaBoolean               isLeader();

    oaGroup                 *getGroup();
    oaObject                *getObject();

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

    enum {dtIndex = oacBaseGroupMemDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaGroup> {
public:
    typedef oaObject            parentType;
    typedef oaGroupModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseGroupDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacGroupType};
    enum {dataTypeEnumVal = oacBaseGroupDataType};
};

template<>
class oaTraits<oaGroupMember> {
public:
    typedef oaObject                    parentType;
    typedef oaGroupMemberModTypeEnum    modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseGroupMemDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacGroupMemberType};
    enum {dataTypeEnumVal = oacBaseGroupMemDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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