oaFigGroup.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaFigGroup.h
//
// This file contains the definition for the oaFigGroup class and its public
// supporting classes. oaFigGroup is a container object used to encapsulate a
// number of oaFigs such that they can be treated as a single oaFig object.
// An oaFigGroup is itself an oaFig, so oaFigGroups can be nested within one
// another.
//
// The public supporting class included here is:
//
//  oaFigGroupMem
//      Each fig is encapsulated in an oaFigGroupMem for membership in an
//      oaFigGroup.
//
//  oaFigGroupStatus
//      The oaFigGroupStatus type describes the values that the status of an
//      oaFigGroup can take.
//
// *****************************************************************************
// 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 2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State$
// *****************************************************************************
// *****************************************************************************

#if !defined(oaFigGroup_P)
#define oaFigGroup_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaFig.h"
#include "oaBlock.h"



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



// *****************************************************************************
// oaFigGroupStatusEnum
// *****************************************************************************
#define oavNumFigGroupStatusTypes  3

enum oaFigGroupStatusEnum {
    oacNormalFigGroupStatus = 0,
    oacFixedFigGroupStatus  = 1,
    oacLockedFigGroupStatus = 2
};



// *****************************************************************************
// oaFigGroupStatus
// *****************************************************************************
class OA_DESIGN_DLL_API oaFigGroupStatus {
public:         
                            oaFigGroupStatus(oaFigGroupStatusEnum valueIn);
                            oaFigGroupStatus(const oaString &name);

    const oaString          &getName() const;

                            operator                oaFigGroupStatusEnum() const;

private:
    static const oaString   *initNames();

    oaFigGroupStatusEnum    value;

    static const oaString   *names;
};



// *****************************************************************************
// oaFigGroup
// *****************************************************************************
class OA_DESIGN_DLL_API oaFigGroup : public oaFig {
public:
    static oaFigGroup                       *create(const oaBlock       *block,
                                                    const oaSimpleName  &name,
                                                    oaBoolean           ordered = false);
    static oaFigGroup                       *create(const oaBlock   *block,
                                                    oaBoolean       ordered = false);

    static oaFigGroup                       *find(const oaBlock         *block,
                                                  const oaSimpleName    &name);

    void                                    getName(oaSimpleName &name) const;
    void                                    getName(const oaNameSpace   &ns,
                                                    oaString            &name) const;
    void                                    getTransform(oaTransform &xform) const;
    void                                    getOrigin(oaPoint &origin) const;
    oaOrient                                getOrient() const;
    oaFigGroupStatus                        getFigGroupStatus() const;
    oaBoolean                               hasDefaultConstraintGroup() const;
    oaConstraintGroup                       *getDefaultConstraintGroup() const;
    oaBoolean                               isOrdered() const;

    void                                    setName(const oaSimpleName &name);
    void                                    setTransform(const oaTransform &xform);
    void                                    setOrigin(const oaPoint &origin);
    void                                    setOrient(oaOrient orient);
    void                                    setFigGroupStatus(oaFigGroupStatus status);
    void                                    setOrdered(oaBoolean ordered = true);

    void                                    destroyFigs(oaBoolean recurse = true);

    oaCollection<oaFigGroupMem, oaFigGroup> getMembers() const;

    enum {dtIndex = oacFigGroupDataType};
};



// *****************************************************************************
// oaFigGroupMem
// *****************************************************************************
class OA_DESIGN_DLL_API oaFigGroupMem : public oaBlockObject {
public:
    static oaFigGroupMem    *create(oaFigGroup  *figGroup,
                                    oaFig       *fig);

    void                    destroy();

    oaFigGroup              *getFigGroup() const;
    oaFig                   *getFig() const;

    void                    moveAfter(oaFigGroupMem *mem);
    void                    moveToFirst();

    enum {dtIndex = oacFigGroupMemDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaFigGroup> {
public:
    typedef oaFig                   parentType;
    typedef oaFigGroupModTypeEnum   modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacFigGroupDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacFigGroupType};
    enum {dataTypeEnumVal = oacFigGroupDataType};
};

template<>
class oaTraits<oaFigGroupMem> {
public:
    typedef oaBlockObject               parentType;
    typedef oaFigGroupMemModTypeEnum    modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacFigGroupMemDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacFigGroupMemType};
    enum {dataTypeEnumVal = oacFigGroupMemDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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