oaModInstHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModInstHeader.h
//
// This file contains the definition for the oaModInstHeader class. The 
// oaModInstHeader class implements an object that contains the module domain
// view about a particular design master and all of the instances that use it.
// oaOccInstHeader objects are scoped within an owner module.
//
// *****************************************************************************
// 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(oaModInstHeader_P)
#define oaModInstHeader_P



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



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



// *****************************************************************************
// oaModInstHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaModInstHeader : public oaModObject {
public:
    static oaModInstHeader                          *find(const oaDesign    *design,
                                                          const oaDesign    *master);
    static oaModInstHeader                          *find(const oaDesign        *design,
                                                          const oaScalarName    &libName,
                                                          const oaScalarName    &cellName,
                                                          const oaScalarName    &viewName);

    oaDesign                                        *getMaster() const;
    oaModule                                        *getMasterModule() const;

    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;
    oaModInstHeader                                 *getSuperHeader() const;

    oaBoolean                                       isBound() const;
    oaBoolean                                       isSuperHeader() const;
    oaBoolean                                       isSubHeader() const;

    oaCollection<oaModDesignInst, oaModInstHeader>  getInsts(oaUInt4    filterFlags = oacInstIterNotImplicit,
                                                             oaModule   *parentModule = NULL) const;
    oaCollection<oaModInstHeader, oaModInstHeader>  getSubHeaders() const;

    enum {dtIndex = oacInstHeaderDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModInstHeader> {
public:
    typedef oaModObject             parentType;
    typedef oaInstHeaderModTypeEnum modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacInstHeaderDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModInstHeaderType};
    enum {dataTypeEnumVal = oacInstHeaderDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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