oaOccInstTerm.h

Go to the documentation of this file.

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



#if !defined(oaOccInstTerm_P)
#define oaOccInstTerm_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaInstTerm.h"
#include "oaModInstTerm.h"
#include "oaModTerm.h"
#include "oaOccInst.h"
#include "oaOccNet.h"



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



// *****************************************************************************
// oaOccInstTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccInstTerm : public oaOccObject {
public:
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaOccTerm   *term);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaModTerm   *term);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaTerm      *term);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaName      &termName);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  oaUInt4           termPosition);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaOccTerm   *term,
                                  oaDomain          domain);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  const oaName      &termName,
                                  oaDomain          domain);
    static oaOccInstTerm    *find(const oaOccInst   *inst,
                                  oaUInt4           termPosition,
                                  oaDomain          domain);

    oaOccInstTerm           *getBit(oaUInt4 bitIndex) const;
    oaOccNet                *getNet(oaBoolean preferred = false) const;
    oaOccInst               *getInst() const;

    oaOccTerm               *getTerm(oaBoolean expand = true) const;
    oaOccTerm               *getTerm(oaBoolean  expand,
                                     oaDomain   d) const;

    void                    getTermName(oaName &name) const;
    void                    getTermName(const oaNameSpace   &ns,
                                        oaString            &name) const;
    oaUInt4                 getTermPosition() const;
    oaUInt4                 getNumBits() const;

    oaOccNet                *getAssignedNet(oaBoolean ignoreDefault = false) const;
    oaOccNet                *getAssignedNet(oaAssignedNetSpec   &spec,
                                            oaBoolean           ignoreDefault = false) const;

    oaInstTerm              *getInstTerm() const;
    oaModInstTerm           *getModInstTerm() const;

    oaOccInstTerm           *getReflection(oaDomain d) const;

    oaBoolean               isBound() const;
    oaBoolean               isBound(oaDomain d) const;
    oaBoolean               isImplicit() const;
    oaBoolean               usesTermPosition() const;

    enum {dtIndex = oacInstTermDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccInstTerm> {
public:
    typedef oaOccObject             parentType;
    typedef oaInstTermModTypeEnum   modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacInstTermDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccInstTermType};
    enum {dataTypeEnumVal = oacInstTermDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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