oaInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaInst.h
//
// This file contains the definition for the oaInst class and its public
// supporting classes. The oaInst class is an abstract base for block domain
// instances. An instance represents the inclusion of one design as a part of
// the contents of another. The design containing the instance is the parent
// design and the design that is included is the master of the instance.
//
// The supporting classes include:
//
//  oaPlacementStatus
//      This simple class represents the placement status which can be 
//      assigned to an instance or a pin.
//
// *****************************************************************************
// 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(oaInst_P)
#define oaInst_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaRef.h"
#include "oaInstHeader.h"



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



// *****************************************************************************
// oaInstAttrTypeEnum
// *****************************************************************************
#define oavNumInstAttrTypes     6


enum oaInstAttrTypeEnum {
    oacLibNameInstAttrType  = 0,
    oacCellNameInstAttrType = 1,
    oacViewNameInstAttrType = 2,
    oacNameInstAttrType     = 3,
    oacNumBitsInstAttrType  = 4,
    oacIsBoundInstAttrType  = 5
};



// *****************************************************************************
// oaInstAttrType
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstAttrType : public oaAttrType {
public:
                            oaInstAttrType(oaInstAttrTypeEnum valueIn);
                            oaInstAttrType(const oaString &name);
                            oaInstAttrType(oaAttrType attr);

    virtual const oaString  &getName() const;

    oaInstAttrTypeEnum      getValue() const;

private:
    static const oaString   names[];
};



// *****************************************************************************
// oaPlacementStatusEnum
// *****************************************************************************
#define oavNumPlacementStatusTypes  5

enum oaPlacementStatusEnum {
    oacNonePlacementStatus      = 0,
    oacUnplacedPlacementStatus  = 1,
    oacPlacedPlacementStatus    = 2,
    oacFixedPlacementStatus     = 3,
    oacLockedPlacementStatus    = 4
};



// *****************************************************************************
// oaPlacementStatus
// *****************************************************************************
class OA_DESIGN_DLL_API oaPlacementStatus {
public:         
                            oaPlacementStatus(oaPlacementStatusEnum valueIn);
                            oaPlacementStatus(const oaString &name);
                            ~oaPlacementStatus();

    const oaString          &getName() const;

                            operator                oaPlacementStatusEnum() const;

private:
    oaPlacementStatusEnum   value;

    static const oaString   names[];
};



// *****************************************************************************
// oaInstUsage defines
// *****************************************************************************
#define oacInstUsageFeedthru    0x0001u
#define oacInstUsageSpare       0x0002u
#define oacInstUsageJTag        0x0004u



// *****************************************************************************
// oaInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaInst : public oaRef {
public:
    static oaInst                       *find(const oaBlock         *block,
                                              const oaSimpleName    &name);

    void                                getLibName(oaScalarName &libName) const;
    void                                getCellName(oaScalarName &cellName) const;
    void                                getViewName(oaScalarName &viewName) const;
    void                                getLibName(const oaNameSpace    &ns,
                                                   oaString             &libName) const;
    void                                getCellName(const oaNameSpace   &ns,
                                                    oaString            &cellName) const;
    void                                getViewName(const oaNameSpace   &ns,
                                                    oaString            &viewName) const;
    oaInstHeader                        *getHeader() const;
    void                                getName(oaSimpleName &name) const;
    void                                getName(const oaNameSpace   &ns,
                                                oaString            &name) const;
    void                                getParams(oaParamArray &params) const;
    oaUInt4                             getNumBits() const;
    oaPlacementStatus                   getPlacementStatus() const;
    oaUInt4                             getPriority() const;
    oaSource                            getSource() const;
    oaUInt4                             getUsage() const;
    oaCluster                           *getCluster() const;

    oaBoolean                           isImplicit() const;
    oaBoolean                           usesTermPositions() const;

    oaBoolean                           findParam(const oaString    &name,
                                                  oaParam           &param);

    void                                setMaster(const oaDesign *master);
    void                                setMaster(const oaScalarName    &libName,
                                                  const oaScalarName    &cellName,
                                                  const oaScalarName    &viewName);
    void                                setParams(const oaParamArray &params);
    void                                setPlacementStatus(oaPlacementStatus status);
    void                                setPriority(oaUInt4 priority);
    void                                setSource(oaSource source);
    void                                setUsage(oaUInt4 usage);

    void                                addToCluster(oaCluster *cluster);
    void                                removeFromCluster();

    void                                scalarize();

    oaOccInst                           *getOccInst() const;

    oaCollection<oaInstTerm, oaInst>    getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaAssignment, oaInst>  getAssignments() const;
    oaCollection<oaBlockage, oaInst>    getBlockagesOwnedBy() const;
    oaCollection<oaOccInst, oaInst>     getOccInsts(const oaOccurrence *top) const;

    enum {dtIndex = oacInstDataType};
};



// *****************************************************************************
// oaBitInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaBitInst : public oaInst {
public:
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaInst> {
public:
    typedef oaRef               parentType;
    typedef oaInstModTypeEnum   modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {isMultiDomain = true};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {abstractTypeEnumVal = oacInstType};
};

template<>
class oaTraits<oaBitInst> {
public:
    typedef oaInstModTypeEnum   modTypeType;
    typedef oaInst              parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacBitInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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