oaCluster.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCluster.h
//
// This file contains the definition for the oaCluster class and its public 
// supporting 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(oaCluster_P)
#define oaCluster_P



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



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


// *****************************************************************************
// oaClusterTypeEnum
// *****************************************************************************
#define oavNumClusterTypes      3

enum oaClusterTypeEnum {
    oacClusterTypeInclusive = 0,
    oacClusterTypeExclusive = 1,
    oacClusterTypeSuggested = 2
};



// *****************************************************************************
// oaClusterType
// *****************************************************************************
class OA_DESIGN_DLL_API oaClusterType {
public:
                            oaClusterType(oaClusterTypeEnum valueIn);
                            oaClusterType(const oaString &name);
                            ~oaClusterType();

    const oaString          &getName() const;

                            operator                oaClusterTypeEnum() const;

private:
    oaClusterTypeEnum       value;

    static const oaString   names[];
};



// *****************************************************************************
// oaCluster
// *****************************************************************************
class OA_DESIGN_DLL_API oaCluster : public oaBlockObject {
public:
    static oaCluster                            *create(oaBlock         *block,
                                                        const oaString  &name,
                                                        oaClusterType   type);

    void                                        destroy();

    static oaCluster                            *find(const oaBlock     *block,
                                                      const oaString    &name);

    oaCluster                                   *getParent() const;
    void                                        getName(oaString &name) const;
    oaClusterType                               getClusterType() const;

    void                                        setName(const oaString &name);
    void                                        setClusterType(oaClusterType type);

    oaBoolean                                   isParent() const;

    void                                        addToCluster(oaCluster *cluster);
    void                                        removeFromCluster();

    oaCollection<oaCluster, oaCluster>          getClusters() const;
    oaCollection<oaInst, oaCluster>             getInsts() const;
    oaCollection<oaClusterBoundary, oaCluster>  getBoundaries() const;
    oaCollection<oaBlockage, oaCluster>         getBlockagesOwnedBy() const;

    enum {dtIndex = oacClusterDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaCluster> {
public:
    typedef oaBlockObject           parentType;
    typedef oaClusterModTypeEnum    modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacClusterDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacClusterType};
    enum {dataTypeEnumVal = oacClusterDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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