oaScalarInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaScalarInst.h
//
// This file contains the definition for the oaScalarInst class. This class
// implements a scalar (single-bit) instance. A scalarInst has a simple name
// with no index.
//
// *****************************************************************************
// 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(oaScalarInst_P)
#define oaScalarInst_P



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



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



// *****************************************************************************
// oaScalarInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaScalarInst : public oaBitInst {
public:
    static oaScalarInst     *create(oaBlock                 *block,
                                    oaDesign                *master,
                                    const oaScalarName      &name,
                                    const oaTransform       &xform,
                                    const oaParamArray      *params = NULL,
                                    oaBlockDomainVisibility view = oacInheritFromTopBlock,
                                    oaPlacementStatus       status = oacNonePlacementStatus);
    static oaScalarInst     *create(oaBlock                 *block,
                                    oaDesign                *master,
                                    const oaTransform       &xform,
                                    const oaParamArray      *params = NULL,
                                    oaBlockDomainVisibility view = oacInheritFromTopBlock,
                                    oaPlacementStatus       status = oacNonePlacementStatus);
    static oaScalarInst     *create(oaBlock                 *block,
                                    const oaScalarName      &libName,
                                    const oaScalarName      &cellName,
                                    const oaScalarName      &viewName,
                                    const oaScalarName      &name,
                                    const oaTransform       &xform,
                                    const oaParamArray      *params = NULL,
                                    oaBlockDomainVisibility view = oacInheritFromTopBlock,
                                    oaPlacementStatus       status = oacNonePlacementStatus);
    static oaScalarInst     *create(oaBlock                 *block,
                                    const oaScalarName      &libName,
                                    const oaScalarName      &cellName,
                                    const oaScalarName      &viewName,
                                    const oaTransform       &xform,
                                    const oaParamArray      *params = NULL,
                                    oaBlockDomainVisibility view = oacInheritFromTopBlock,
                                    oaPlacementStatus       status = oacNonePlacementStatus);

    static oaScalarInst     *find(const oaBlock         *block,
                                  const oaScalarName    &name);

    static oaBoolean        isValidName(const oaBlock       *block,
                                        const oaScalarName  &name);

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

    void                    setName(const oaScalarName &name);

    using                   oaInst::copy;
    oaScalarInst            *copy(const oaScalarName    &name,
                                  const oaTransform     &xform);
    oaScalarInst            *copy(const oaScalarName    &name,
                                  const oaTransform     &xform,
                                  oaBlock               *block);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaScalarInst> {
public:
    typedef oaInstModTypeEnum   modTypeType;
    typedef oaBitInst           parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacScalarInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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