oaModVectorInstBit.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModVectorInstBit.h
//
// This file contains the definition for the oaModVectorInstBit class. The
// oaModVectorInstBit class implements a single bit of a vectorInst in a module.
// VectorInstBits are automatically created and destroyed as vectorInsts are
// created or destroyed. Implicitly created vectorInstBits cannot be modified
// to insure consistency with its defining vectorInst. Explicitly created
// vectorInstBits define a unique bit of a vectorInst definition since the bits
// of a vectorInst are not allowed to overlap with other 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 2004-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaModVectorInstBit_P)
#define oaModVectorInstBit_P



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



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



// *****************************************************************************
// oaModVectorInstBit
// *****************************************************************************
class OA_DESIGN_DLL_API oaModVectorInstBit : public oaModBitInst {
public:
    static oaModVectorInstBit   *create(oaModule            *module,
                                        oaDesign            *master,
                                        const oaScalarName  &baseName,
                                        oaUInt4             bitIndex,
                                        const oaParamArray  *params = NULL);
    static oaModVectorInstBit   *create(oaModule            *module,
                                        const oaScalarName  &libName,
                                        const oaScalarName  &cellName,
                                        const oaScalarName  &viewName,
                                        const oaScalarName  &baseName,
                                        oaUInt4             bitIndex,
                                        const oaParamArray  *params = NULL);

    static oaModVectorInstBit   *find(const oaModule        *module,
                                      const oaScalarName    &baseName,
                                      oaUInt4               bitIndex);

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

    oaModVectorInstDef          *getDef() const;
    oaUInt4                     getBitIndex() const;

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

    void                        setName(const oaScalarName  &baseName,
                                        oaUInt4             bitIndex);
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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