oaModModuleVectorInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModModuleVectorInst.h
//
// This file contains the definition for the oaModModuleVectorInst class. This 
// class implements a logical vector instance of 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaModModuleVectorInst_P)
#define oaModModuleVectorInst_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaModVectorInstDef.h"
#include "oaModModuleInst.h"



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



// *****************************************************************************
// oaModModuleVectorInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaModModuleVectorInst : public oaModModuleInst {
public:
    static oaModModuleVectorInst    *create(oaModule            *module,
                                            oaModule            *master,
                                            const oaScalarName  &baseName,
                                            oaUInt4             start,
                                            oaUInt4             stop);

    static oaModModuleVectorInst    *create(oaModule            *module,
                                            const oaScalarName  &masterModuleName,
                                            const oaScalarName  &baseName,
                                            oaUInt4             start,
                                            oaUInt4             stop);

    static oaModModuleVectorInst    *find(const oaModule        *module,
                                          const oaScalarName    &baseName,
                                          oaUInt4               start,
                                          oaUInt4               stop);

    static oaBoolean                isValidName(const oaModule      *module,
                                                const oaScalarName  &baseName,
                                                oaUInt4             start,
                                                oaUInt4             stop);

    oaModVectorInstDef              *getDef() const;
    oaUInt4                         getStart() const;
    oaUInt4                         getStop() const;
    oaModModuleVectorInstBit        *getBit(oaUInt4 bitIndex) const;

    using                           oaModInst::getName;
    void                            getName(oaVectorName &name) const;

    void                            setBaseName(const oaScalarName &baseName);
    void                            setRange(oaUInt4    start,
                                             oaUInt4    stop);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModModuleVectorInst> {
public:
    typedef oaInstModTypeEnum   modTypeType;
    typedef oaModModuleInst     parentType;
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModModuleVectorInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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