oaModVectorInstDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModVectorInstDef.h
//
// This file contains the definition for the oaModVectorInstDef class. The 
// oaModVectorInstDef class implements the definition of a vectorInst, including 
// its name and bit-range. A vectorInstDef is never created by applications.
// Instead, it is automatically created whenever applications create
// vectorInsts. Since multiple vectorInsts can refer to different members of the
// same vectorInst definition, the vectorInstDef represents the super-set of all
// members of the vectorInsts.
//
// *****************************************************************************
// 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(oaModVectorInstDef_P)
#define oaModVectorInstDef_P



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



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



// *****************************************************************************
// oaModVectorInstDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaModVectorInstDef : public oaModObject {
public:
    static oaModVectorInstDef                   *create(const oaModule      *module,
                                                        const oaScalarName  &name,
                                                        oaBitOrder          order);

    static oaModVectorInstDef                   *find(const oaModule        *module,
                                                      const oaScalarName    &name);

    void                                        destroy();

    oaUInt4                                     getMinIndex() const;
    oaUInt4                                     getMaxIndex() const;
    oaUInt4                                     getNumBits() const;
    void                                        getName(oaScalarName &name) const;
    void                                        getName(const oaNameSpace   &ns,
                                                        oaString            &name) const;
    oaBitOrder                                  getBitOrder() const;

    oaBoolean                                   isImplicit() const;

    void                                        setBitOrder(oaBitOrder order);

    oaCollection<oaModInst, oaModVectorInstDef> getVectorInsts() const;
    oaCollection<oaModInst, oaModVectorInstDef> getVectorInstBits() const;

    enum {dtIndex = oacVectorInstDefDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModVectorInstDef> {
public:
    typedef oaModObject                 parentType;
    typedef oaVectorInstDefModTypeEnum  modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacVectorInstDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModVectorInstDefType};
    enum {dataTypeEnumVal = oacVectorInstDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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