oaModScalarInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModScalarInst.h
//
// This file contains the definition for the oaModScalarInst class. This class
// implements a logical scalar (i.e. single-bit) instance of design 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(oaModScalarInst_P)
#define oaModScalarInst_P



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



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



// *****************************************************************************
// oaModScalarInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaModScalarInst : public oaModBitInst {
public:
    static oaModScalarInst  *create(oaModule            *module,
                                    oaDesign            *master,
                                    const oaScalarName  &name,
                                    const oaParamArray  *params = NULL);

    static oaModScalarInst  *create(oaModule            *module,
                                    oaDesign            *master,
                                    const oaParamArray  *params = NULL);

    static oaModScalarInst  *create(oaModule            *module,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    const oaScalarName  &name,
                                    const oaParamArray  *params = NULL);

    static oaModScalarInst  *create(oaModule            *module,
                                    const oaScalarName  &libName,
                                    const oaScalarName  &cellName,
                                    const oaScalarName  &viewName,
                                    const oaParamArray  *params = NULL);

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

    static oaBoolean        isValidName(const oaModule      *module,
                                        const oaScalarName  &name);

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

    void                    setName(const oaScalarName &name);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModScalarInst> {
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 = oacModScalarInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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