oaLayerHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaLayerHeader.h
//
// This file contains the definition for the oaLayerHeader class and its public
// supporting classes. The oaLayerHeader class implements an object that holds
// information about a particular layer and the set of figures that use it in a
// design database. The set of oaLayerHeaders in a design represent the set of
// individual layers currently in use.
//
// *****************************************************************************
// 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(oaLayerHeader_P)
#define oaLayerHeader_P



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



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



// *****************************************************************************
// oaLayerHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaLayerHeader : public oaBlockObject {
public:
    static oaLayerHeader                        *find(const oaBlock *block,
                                                      oaLayerNum    layerNum);

    oaLayer                                     *getLayer() const;
    oaLayerNum                                  getLayerNum() const;
    void                                        getSteinerBBox(oaBox &bBox) const;
    void                                        getBlockageBBox(oaBox &bBox) const;
    void                                        getGuideBBox(oaBox &bBox) const;

    oaCollection<oaSteiner, oaLayerHeader>      getSteiners() const;
    oaCollection<oaBlockage, oaLayerHeader>     getBlockages() const;
    oaCollection<oaGuide, oaLayerHeader>        getGuides(oaUInt4 filterFlags
                                                          = oacGuideIterBeginAndEndLayers) const;
    oaCollection<oaLPPHeader, oaLayerHeader>    getLPPHeaders() const;

    oaBoolean                                   isBound() const;

    enum {dtIndex = oacLayerHeaderDataType};
};



// *****************************************************************************
// oaLayerHeaderArray
// *****************************************************************************
class OA_DESIGN_DLL_API oaLayerHeaderArray : public oaArray<oaLayerHeader*> {
public:
                            oaLayerHeaderArray(oaUInt4 sizeIn = 0);
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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