oaFrame.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaFrame.h
//
// This file contains the definition for the oaFrame class and its public
// supporting classes. The oaFrame class defines a non-printing area into which
// a series of frame or design instances are placed. Frames are hierarchical
// so that in a shuttle-style (multi-project chip) reticle, a lower-level
// frame can be used to organize the number of different die instances into a
// larger component and then a top-level frame can be used to organize the
// shuttle die into the NxN locations on the reticle.
//
// *****************************************************************************
// 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 2004-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaFrame_P)
#define oaFrame_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBox.h"
#include "oaWaferModTypes.h"
#include "oaWafer.h"



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



// *****************************************************************************
// oaFrame
// *****************************************************************************
class OA_WAFER_DLL_API oaFrame : public oaWaferObject {
public:
    static oaFrame                      *create(oaWafer         *wafer,
                                                const oaString  &name,
                                                const oaBox     &boundaryBox);

    static oaFrame                      *find(const oaWafer     *wafer,
                                              const oaString    &name);

    void                                destroy();

    void                                getName(oaString &name) const;
    void                                getBoundaryBox(oaBox &boundaryBox) const;

    void                                setName(const oaString &name);
    void                                setBoundaryBox(const oaBox &boundaryBox);

    oaCollection<oaFrameInst, oaFrame>  getFrameInsts() const;
    oaCollection<oaDesignInst, oaFrame> getDesignInsts() const;

    enum {dtIndex = oacFrameWaferDataType};
};



// *****************************************************************************
// Wafer traits.
// *****************************************************************************
template<>
class oaTraits<oaFrame> {
public:
    typedef oaWaferObject       parentType;
    typedef oaFrameModTypeEnum  modTypeType;
    enum {dbType = oacWaferDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacFrameWaferDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacFrameType};
    enum {dataTypeEnumVal = oacFrameWaferDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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