oaModule.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModule.h
//
// This file contains the definition for the oaModule class and its public
// supporting classes. The oaModule class represents a level of logical 
// hierarchy in a design. It implements methods for accessing information which
// is contained in the module. There are zero or one top modules in a design.
// There may be several levels of module hierarchy within a design, so each 
// module may contain other modules.
//
// *****************************************************************************
// 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(oaModule_P)
#define oaModule_P



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



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



// *****************************************************************************
// oaDetachVisibilityEnum
// *****************************************************************************
enum oaDetachVisibilityEnum {
    oacInheritFromSourceModuleDetachVisibility  = 0,
    oacVisibleToBlockDomainDetachVisibility     = 1,
    oacExcludeFromBlockDomainDetachVisibility   = 2
};



// *****************************************************************************
// oaModule
// *****************************************************************************
class OA_DESIGN_DLL_API oaModule : public oaModObject {
public:
    static oaModule                                 *create(const oaDesign      *design,
                                                            const oaScalarName  &name);
    static oaModule                                 *create(const oaDesign *design);

    void                                            destroy();

    oaDesign                                        *detach(const oaScalarName      &libName,
                                                            const oaScalarName      &cellName,
                                                            const oaScalarName      &viewName,
                                                            oaDetachVisibilityEnum  view = oacInheritFromSourceModuleDetachVisibility);

    static oaModule                                 *find(const oaDesign        *design,
                                                          const oaScalarName    &name);

    static oaModule                                 *embed(oaDesign         *design,
                                                           const oaDesign   *master);

    void                                            getName(oaScalarName &name) const;
    void                                            getName(const oaNameSpace   &nameSpace,
                                                            oaString            &nameStr) const;
    void                                            getOrig(oaScalarName    &name,
                                                            oaScalarName    &libName,
                                                            oaScalarName    &cellName,
                                                            oaScalarName    &viewName) const;

    oaBoolean                                       isDerived() const;
    oaBoolean                                       isEmbedded() const;
    oaBoolean                                       isVariant(oaModule *module) const;
    oaBoolean                                       isClone(oaModule *module) const;
    oaBoolean                                       isOrigModified(oaModule *module) const;

    oaBlock                                         *getBlock() const;
    void                                            getTermsByPosition(oaModTermArray &array) const;

    oaBoolean                                       hasDefaultConstraintGroup() const;
    oaConstraintGroup                               *getDefaultConstraintGroup() const;

    oaCollection<oaModAssignment, oaModule>         getAssignments() const;
    oaCollection<oaModBusNetDef, oaModule>          getBusNetDefs() const;
    oaCollection<oaModBusTermDef, oaModule>         getBusTermDefs() const;
    oaCollection<oaModConnectDef, oaModule>         getConnectDefs() const;
    oaCollection<oaModModuleInstHeader, oaModule>   getModuleInstHeaders() const;
    oaCollection<oaModInst, oaModule>               getInsts(oaUInt4 filterFlags = oacInstIterNotImplicit) const;
    oaCollection<oaModInstTerm, oaModule>           getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaModNet, oaModule>                getNets(oaUInt4 filterFlags
                                                            = oacNetIterAll
                                                            | oacNetIterNotImplicit) const;
    oaCollection<oaModTerm, oaModule>               getTerms(oaUInt4 filterFlags
                                                             = oacTermIterAll
                                                             | oacTermIterNotImplicit) const;
    oaCollection<oaModVectorInstDef, oaModule>      getVectorInstDefs() const;
    oaCollection<oaOccurrence, oaModule>            getOccurrences(const oaOccurrence *top) const;

    enum {dtIndex = oacModuleDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModule> {
public:
    typedef oaModObject         parentType;
    typedef oaModuleModTypeEnum modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacModuleDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModuleType};
    enum {dataTypeEnumVal = oacModuleDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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