oaModModuleInstHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModModuleInstHeader.h
//
// This file contains the definition for the oaModModuleInstHeader class. The 
// oaModModuleInstHeader class implements an object that contains information 
// about a particular module master and all of the logical instances that use 
// it. oaModModuleInstHeader objects are scoped within the 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(oaModModuleInstHeader_P)
#define oaModModuleInstHeader_P



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



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



// *****************************************************************************
// oaModModuleInstHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaModModuleInstHeader : public oaModObject {
public:
    static oaModModuleInstHeader                            *find(const oaModule    *module,
                                                                  const oaModule    *master);
    static oaModModuleInstHeader                            *find(const oaModule        *module,
                                                                  const oaScalarName    &masterModuleName);

    oaModule                                                *getMasterModule() const;

    void                                                    getName(oaScalarName &name) const;
    void                                                    getName(const oaNameSpace   &ns,
                                                                    oaString            &name) const;

    oaBoolean                                               isBound() const;

    oaCollection<oaModModuleInst, oaModModuleInstHeader>    getInsts(oaUInt4 filterFlags = oacInstIterNotImplicit) const;

    enum {dtIndex = oacModuleInstHeaderDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModModuleInstHeader> {
public:
    typedef oaModObject                     parentType;
    typedef oaModuleInstHeaderModTypeEnum   modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacModuleInstHeaderDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModModuleInstHeaderType};
    enum {dataTypeEnumVal = oacModuleInstHeaderDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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