oaLPPHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaLPPHeader.h
//
// This file contains the definition for the oaLPPHeader class and its public
// supporting classes. The oaLPPHeader class implements an object that contains
// information about a particular layer-purpose pair and the set of figures that
// use it in a design database. The set of oaLPPHeaders in a design 
// represents the set of layer-purpose pairs 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(oaLPPHeader_P)
#define oaLPPHeader_P



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



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



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

    oaLayer                             *getLayer() const;
    oaPurpose                           *getPurpose() const;
    oaLayerHeader                       *getLayerHeader() const;
    oaLayerNum                          getLayerNum() const;
    oaPurposeNum                        getPurposeNum() const;
    void                                getShapeBBox(oaBox &bBox) const;

    oaCollection<oaShape, oaLPPHeader>  getShapes() const;

    oaBoolean                           isBound() const;

    enum {dtIndex = oacLPPHeaderDataType};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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