oaModInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModInst.h
//
// This file contains the definition for the oaModInst class and its public
// supporting classes. The oaModInst class is an abstract base class for 
// logical instances of either design or embedded module master.
//
// *****************************************************************************
// 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(oaModInst_P)
#define oaModInst_P



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



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



// *****************************************************************************
// oaModInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaModInst : public oaModObject {
public:
    static oaModInst                            *find(const oaModule        *module,
                                                      const oaSimpleName    &name);

    void                                        destroy();

    oaModule                                    *getMasterModule() const;

    void                                        getName(oaSimpleName &name) const;
    void                                        getName(const oaNameSpace   &ns,
                                                        oaString            &name) const;
    oaUInt4                                     getNumBits() const;

    oaBoolean                                   isBound() const;
    oaBoolean                                   isImplicit() const;
    oaBoolean                                   isModDesignInst() const;
    oaBoolean                                   isModModuleInst() const;
    oaBoolean                                   usesTermPositions() const;

    void                                        scalarize();

    oaCollection<oaModInstTerm, oaModInst>      getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaModAssignment, oaModInst>    getAssignments() const;
    oaCollection<oaOccInst, oaModInst>          getOccInsts(const oaOccurrence *top) const;

    enum {dtIndex = oacInstDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModInst> {
public:
    typedef oaModObject         parentType;
    typedef oaInstModTypeEnum   modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {abstractTypeEnumVal = oacModInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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