oaOccTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccTerm.h
//
// This file contains the definition for the oaOccTerm class and its public
// suppporting classes. The oaOccTerm class is an abstract base for occurrences
// of all types terminals.
//
// *****************************************************************************
// 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(oaOccTerm_P)
#define oaOccTerm_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaModTerm.h"
#include "oaOccNet.h"



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



// *****************************************************************************
// oaOccTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccTerm : public oaOccObject {
public:
    static oaOccTerm        *find(const oaOccurrence    *occurrence,
                                  const oaName          &name);
    static oaOccTerm        *find(const oaOccurrence    *occurrence,
                                  oaUInt4               position);

    static oaOccTerm        *find(const oaOccurrence    *occurrence,
                                  const oaName          &name,
                                  oaDomain              d);
    static oaOccTerm        *find(const oaOccurrence    *occurrence,
                                  oaUInt4               position,
                                  oaDomain              d);

    static oaUInt4          getMaxPosition(const oaOccurrence *occurrence);

    oaBoolean               isImplicit() const;
    oaBoolean               isInterface() const;

    oaOccBitTerm            *getBit(oaUInt4 bitIndex) const;
    oaOccNet                *getNet(oaBoolean preferred = false) const;
    oaUInt4                 getNumBits() const;
    oaTermType              getTermType() const;
    oaUInt4                 getPosition() const;

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

    oaTerm                  *getTerm() const;
    oaModTerm               *getModTerm() const;

    oaOccTerm               *getReflection(oaDomain d) const;

    void                    getName(oaName &name) const;
    void                    getName(const oaNameSpace   &ns,
                                    oaString            &name) const;

    enum {dtIndex = oacTermDataType};
};



// *****************************************************************************
// oaOccBitTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccBitTerm : public oaOccTerm {
public:
    oaOccTermConnectDef     *getConnectDef() const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccBitTerm> {
public:
    typedef oaTermModTypeEnum   modTypeType;
    typedef oaOccTerm           parentType;
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacOccBitTermType};
};

template<>
class oaTraits<oaOccTerm> {
public:
    typedef oaOccObject         parentType;
    typedef oaTermModTypeEnum   modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {abstractTypeEnumVal = oacOccTermType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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