oaModInstTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModInstTerm.h
//
// This file contains the definition for the oaModInstTerm class. The
// oaModInstTerm class is an object for managing all types of connections
// between a net and a terminal of an instance in the module domain.
//
// *****************************************************************************
// 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$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaModInstTerm_P)
#define oaModInstTerm_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaNetTermArray.h"
#include "oaModInst.h"
#include "oaModNet.h"



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



// *****************************************************************************
// oaModInstTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaModInstTerm : public oaModObject {
public:
    static oaModInstTerm                        *create(oaModNet    *net,
                                                        oaModInst   *inst,
                                                        oaModTerm   *term);
    static oaModInstTerm                        *create(oaModNet        *net,
                                                        oaModInst       *inst,
                                                        const oaName    &termName);
    static oaModInstTerm                        *create(oaModNet    *net,
                                                        oaModInst   *inst,
                                                        oaUInt4     termPosition);
    static void                                 create(oaModInst                *inst,
                                                       const oaModNetTermArray  &connData);
    static void                                 create(oaModInst                    *inst,
                                                       const oaModNetTermNameArray  &connData);
    static void                                 create(oaModInst                    *inst,
                                                       const oaModNetTermPosArray   &connData);

    static oaModInstTerm                        *find(const oaModInst   *inst,
                                                      const oaModTerm   *term);
    static oaModInstTerm                        *find(const oaModInst   *inst,
                                                      const oaName      &termName);
    static oaModInstTerm                        *find(const oaModInst   *inst,
                                                      oaUInt4           termPosition);

    void                                        destroy();

    oaModInstTerm                               *getBit(oaUInt4 bitIndex) const;
    oaModNet                                    *getNet(oaBoolean preferred = false) const;
    oaModInst                                   *getInst() const;
    oaModTerm                                   *getTerm() const;
    void                                        getTermName(oaName &name) const;
    void                                        getTermName(const oaNameSpace   &ns,
                                                            oaString            &name) const;
    oaUInt4                                     getTermPosition() const;
    oaUInt4                                     getNumBits() const;
    oaBoolean                                   isBound() const;
    oaBoolean                                   isImplicit() const;
    oaBoolean                                   usesTermPosition() const;

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

    void                                        scalarize();

    oaCollection<oaOccInstTerm, oaModInstTerm>  getOccInstTerms(const oaOccurrence *top) const;

    enum {dtIndex = oacInstTermDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModInstTerm> {
public:
    typedef oaModObject             parentType;
    typedef oaInstTermModTypeEnum   modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacInstTermDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModInstTermType};
    enum {dataTypeEnumVal = oacInstTermDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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