oaInstTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaInstTerm.h
//
// This file contains the definition for the oaInstTerm class. The oaInstTerm
// class is an abstract base for all types of connections between a net and a
// terminal of an instance.
//
// *****************************************************************************
// 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$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaInstTerm_P)
#define oaInstTerm_P



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



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



// *****************************************************************************
// oaInstTermAttrTypeEnum
// *****************************************************************************
#define oavNumInstTermAttrTypes 1


enum oaInstTermAttrTypeEnum {    oacNameInstTermAttrType            = 0};



// *****************************************************************************
// oaInstTermAttrType
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstTermAttrType : public oaAttrType {
public:
                            oaInstTermAttrType(oaInstTermAttrTypeEnum valueIn);
                            oaInstTermAttrType(const oaString &name);
                            oaInstTermAttrType(oaAttrType attr);
    virtual inline          ~oaInstTermAttrType();

    virtual const oaString  &getName() const;

    oaInstTermAttrTypeEnum  getValue() const;

private:
    static const oaString   names[];
};



// *****************************************************************************
// oaInstTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaInstTerm : public oaBlockObject {
public:
    static oaInstTerm                       *create(oaNet                   *net,
                                                    oaInst                  *inst,
                                                    oaTerm                  *term,
                                                    oaBlockDomainVisibility view = oacInheritFromTopBlock);
    static oaInstTerm                       *create(oaNet                   *net,
                                                    oaInst                  *inst,
                                                    const oaName            &termName,
                                                    oaBlockDomainVisibility view = oacInheritFromTopBlock);
    static oaInstTerm                       *create(oaNet                   *net,
                                                    oaInst                  *inst,
                                                    oaUInt4                 termPosition,
                                                    oaBlockDomainVisibility view = oacInheritFromTopBlock);
    static void                             create(oaInst                   *inst,
                                                   const oaNetTermArray     &connData,
                                                   oaBlockDomainVisibility  view = oacInheritFromTopBlock);
    static void                             create(oaInst                   *inst,
                                                   const oaNetTermNameArray &connData,
                                                   oaBlockDomainVisibility  view = oacInheritFromTopBlock);
    static void                             create(oaInst                   *inst,
                                                   const oaNetTermPosArray  &connData,
                                                   oaBlockDomainVisibility  view = oacInheritFromTopBlock);

    static oaInstTerm                       *find(const oaInst  *inst,
                                                  const oaTerm  *term);
    static oaInstTerm                       *find(const oaInst  *inst,
                                                  const oaName  &termName);
    static oaInstTerm                       *find(const oaInst  *inst,
                                                  oaUInt4       termPosition);

    void                                    destroy();
    void                                    hide();

    oaInstTerm                              *getBit(oaUInt4 bitIndex) const;
    oaNet                                   *getNet(oaBoolean preferred = false) const;
    oaInst                                  *getInst() const;
    oaTerm                                  *getTerm() const;
    void                                    getTermName(oaName &name) const;
    void                                    getTermName(const oaNameSpace   &ns,
                                                        oaString            &name) const;
    oaUInt4                                 getTermPosition() const;
    oaUInt4                                 getNumBits() const;
    oaRouteMethod                           getRouteMethod() const;
    oaBoolean                               isBound() const;
    oaBoolean                               isImplicit() const;
    oaBoolean                               usesTermPosition() const;

    void                                    addToNet(oaNet *net);
    void                                    removeFromNet();

    void                                    setRouteMethod(oaRouteMethod routeMethod);
    void                                    scalarize();

    oaOccInstTerm                           *getOccInstTerm() const;

    oaCollection<oaRoute, oaInstTerm>       getConnRoutes() const;
    oaCollection<oaOccInstTerm, oaInstTerm> getOccInstTerms(const oaOccurrence *top) const;

    enum {dtIndex = oacInstTermDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaInstTerm> {
public:
    typedef oaBlockObject           parentType;
    typedef oaInstTermModTypeEnum   modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = true};
    enum {dtIndex = oacInstTermDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacInstTermType};
    enum {dataTypeEnumVal = oacInstTermDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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