oaFrameInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaFrameInst.h
//
// This file contains the definition for the oaFrameInst 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 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaFrameInst_P)
#define oaFrameInst_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaTransform.h"
#include "oaFrame.h"
#include "oaReticle.h"



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



// *****************************************************************************
// oaFrameInst
// *****************************************************************************
class OA_WAFER_DLL_API oaFrameInst : public oaWaferObject {
public:
    static oaFrameInst      *create(oaReticle           *reticle,
                                    oaFrame             *master,
                                    const oaString      &name,
                                    oaFloat             mag,
                                    const oaTransform   &xform);
    static oaFrameInst      *create(oaFrame             *frame,
                                    oaFrame             *master,
                                    const oaString      &name,
                                    oaFloat             mag,
                                    const oaTransform   &xform);

    void                    destroy();

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

    void                    getName(oaString &name) const;
    oaFrame                 *getMaster() const;
    oaFloat                 getMag() const;
    void                    getOrigin(oaPoint &origin) const;
    oaOrient                getOrient() const;
    void                    getTransform(oaTransform &xform) const;
    oaWaferObject           *getOwner() const;

    void                    setName(const oaString &name);
    void                    setOrigin(const oaPoint &origin);
    void                    setOrient(oaOrient orient);
    void                    setTransform(const oaTransform &xform);
    void                    setMag(oaFloat mag);

    enum {dtIndex = oacFrameInstWaferDataType};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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