oaModTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModTerm.h
//
// This file contains the definition for the oaModTerm class and its public
// suppporting class. The oaModTerm class is an abstract base for all types of
// terminals 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: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaModTerm_P)
#define oaModTerm_P



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



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



// *****************************************************************************
// oaModTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaModTerm : public oaModObject {
public:
    static oaModTerm                    *create(oaModNet        *modNet,
                                                const oaName    &name,
                                                oaTermType      termType = oacInputOutputTermType);

    static oaModTerm                    *find(const oaModule    *module,
                                              const oaName      &name);
    static oaModTerm                    *find(const oaModule    *module,
                                              oaUInt4           position);

    static oaBoolean                    isValidName(const oaModNet  *net,
                                                    const oaName    &name);

    static oaUInt4                      getMaxPosition(const oaModule *module);

    void                                destroy();

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

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

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

    void                                moveToNet(oaModNet *net);

    void                                setTermType(oaTermType termType);
    void                                setIsInterface(oaBoolean isInterface);

    void                                setPosition(oaUInt4 position);
    void                                unsetPosition();

    void                                scalarize();

    oaCollection<oaOccTerm, oaModTerm>  getOccTerms(const oaOccurrence *top) const;

    enum {dtIndex = oacTermDataType};
};



// *****************************************************************************
// oaModBitTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBitTerm : public oaModTerm {
public:
    oaModTermConnectDef     *getConnectDef() const;
};



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

template<>
class oaTraits<oaModBitTerm> {
public:
    typedef oaTermModTypeEnum   modTypeType;
    typedef oaModTerm           parentType;
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacModBitTermType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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