oaModNet.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModNet.h
//
// This file contains the definition for the oaModNet and oaModBitNet classes
// and their public supporting classes. The oaModNet class is an abstract base
// for all types of logical nets. The oaModBitNet class is the base class for
// all single-bit nets.
//
// *****************************************************************************
// 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(oaModNet_P)
#define oaModNet_P



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



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



// *****************************************************************************
// oaModNet
// *****************************************************************************
class OA_DESIGN_DLL_API oaModNet : public oaModObject {
public:
    static oaModNet                         *create(oaModule        *module,
                                                    const oaName    &name,
                                                    oaSigType       type = oacSignalSigType,
                                                    oaBoolean       isGlobal = false);

    static oaModNet                         *find(const oaModule    *module,
                                                  const oaName      &name);

    static oaBoolean                        isValidName(const oaModule  *module,
                                                        const oaName    &name);

    void                                    destroy();

    oaBoolean                               isEmpty() const;
    oaBoolean                               isImplicit() const;
    oaBoolean                               isGlobal() const;

    oaSigType                               getSigType() const;
    oaUInt4                                 getNumBits() const;
    void                                    getName(oaName &name) const;
    void                                    getName(const oaNameSpace   &ns,
                                                    oaString            &name) const;
    oaModBitNet                             *getBit(oaUInt4 bitIndex) const;

    void                                    setGlobal(oaBoolean isGlobal);
    void                                    setSigType(oaSigType sigType);

    void                                    scalarize();

    oaCollection<oaModInstTerm, oaModNet>   getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaModMemNetCollection                   getMemberNets(oaBoolean unique = true) const;
    oaCollection<oaOccNet, oaModNet>        getOccNets(const oaOccurrence *occ) const;
    oaCollection<oaModBitNet, oaModNet>     getSingleBitMembers() const;
    oaCollection<oaModTerm, oaModNet>       getTerms(oaUInt4 filterFlags = oacTermIterNotImplicit) const;

    enum {dtIndex = oacNetDataType};
};



// *****************************************************************************
// oaModBitNet
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBitNet : public oaModNet {
public:
    oaBoolean                               isPreferredEquivalent() const;

    oaModNetConnectDef                      *getConnectDef() const;
    oaModBitNet                             *getPreferredEquivalent() const;

    void                                    setPreferredEquivalent();

    void                                    makeEquivalent(oaModBitNet *equivNet);
    void                                    breakEquivalence();
    oaBoolean                               hasImplicitEquivalence() const;

    oaCollection<oaModBitNet, oaModBitNet>  getEquivalentNets() const;
    oaCollection<oaModBitNet, oaModBitNet>  getEquivalentNets(oaUInt4 filterFlags) const;
};



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

template<>
class oaTraits<oaModBitNet> {
public:
    typedef oaNetModTypeEnum    modTypeType;
    typedef oaModNet            parentType;
    enum {dtIndex = oacNetDataType};
    enum {dataTypeEnumVal = oacNetDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacModBitNetType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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