oaInstHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaInstHeader.h
//
// This file contains the definition for the oaInstHeader class and its public
// supporting classes. The oaInstHeader class implements an object that contains
// information about a particular design master and all of the instances that
// use it.
//
// *****************************************************************************
// 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(oaInstHeader_P)
#define oaInstHeader_P



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



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



// *****************************************************************************
// oaInstHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstHeader : public oaRefHeader {
public:
    static oaInstHeader                         *find(const oaBlock     *block,
                                                      const oaDesign    *master);
    static oaInstHeader                         *find(const oaBlock         *block,
                                                      const oaScalarName    &libName,
                                                      const oaScalarName    &cellName,
                                                      const oaScalarName    &viewName);
    static void                                 setMaster(oaInstHeader          *header,
                                                          const oaDesign        *master,
                                                          const oaParamArray    *params = NULL);

    void                                        getLibName(oaScalarName &libName) const;
    void                                        getCellName(oaScalarName &cellName) const;
    void                                        getViewName(oaScalarName &viewName) const;
    void                                        getLibName(const oaNameSpace    &ns,
                                                           oaString             &libName) const;
    void                                        getCellName(const oaNameSpace   &ns,
                                                            oaString            &cellName) const;
    void                                        getViewName(const oaNameSpace   &ns,
                                                            oaString            &viewName) const;
    void                                        getParams(oaParamArray &params) const;
    void                                        getAllParams(oaParamArray &params) const;

    oaBoolean                                   findParam(const oaString    &name,
                                                          oaParam           &param);

    void                                        setMasterBBox(const oaBox &bBox);

    oaCollection<oaInst, oaInstHeader>          getInsts(oaUInt4 filterFlags = oacInstIterNotImplicit) const;
    oaCollection<oaInstHeader, oaInstHeader>    getSubHeaders() const;

    enum {dtIndex = oacInstHeaderDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaInstHeader> {
public:
    typedef oaRefHeader             parentType;
    typedef oaInstHeaderModTypeEnum modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacInstHeaderDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacInstHeaderType};
    enum {dataTypeEnumVal = oacInstHeaderDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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