oaOccNet.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccNet.h
//
// This file contains the definition for the oaOccNet class and its public
// supporting classes. The oaOccNet class is an abstract base for all types
// of occurrence nets.
//
//  oaAssignmentNetSpec
//      This class implements an array of pointers to objects that may be
//      either connectDef objects or assignment objects in either the module
//      or occurence 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(oaOccNet_P)
#define oaOccNet_P



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



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



// *****************************************************************************
// oaAssignedNetSpec
// *****************************************************************************
class OA_DESIGN_DLL_API oaAssignedNetSpec : public oaArray<oaDesignObject*> {
public:
                            oaAssignedNetSpec(oaUInt4 sizeIn = 0);
};



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

    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;
    void                                    getPathName(oaName &pathName) const;
    void                                    getPathName(const oaNameSpace   &ns,
                                                        oaString            &pathName) const;

    oaOccBitNet                             *getBit(oaUInt4 bitIndex) const;

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

    oaNet                                   *getNet() const;
    oaModNet                                *getModNet() const;

    oaCollection<oaOccNet, oaOccNet>        getGlobalNets() const;
    oaCollection<oaOccInstTerm, oaOccNet>   getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaOccMemNetCollection                   getMemberNets(oaBoolean unique = true) const;
    oaCollection<oaOccBitNet, oaOccNet>     getSingleBitMembers() const;
    oaCollection<oaOccNet, oaOccNet>        getSpan() const;
    oaCollection<oaOccTerm, oaOccNet>       getTerms(oaUInt4 filterFlags = oacTermIterAllNotHidden | oacTermIterNotImplicit) const;

    enum {dtIndex = oacNetDataType};
};



// *****************************************************************************
// oaOccBitNet
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccBitNet : public oaOccNet {
public:
    oaBoolean                               isPreferredEquivalent() const;

    oaOccNetConnectDef                      *getConnectDef() const;
    oaOccBitNet                             *getPreferredEquivalent() const;
    void                                    getParasiticConfidence(oaUInt4  &minValue,
                                                                   oaUInt4  &maxValue) const;

    void                                    setParasiticConfidence(oaUInt4 value);
    void                                    setParasiticConfidence(oaUInt4  minValue,
                                                                   oaUInt4  maxValue);

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



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

template<>
class oaTraits<oaOccBitNet> {
public:
    typedef oaNetModTypeEnum    modTypeType;
    typedef oaOccNet            parentType;
    enum {dtIndex = oacNetDataType};
    enum {dataTypeEnumVal = oacNetDataType};
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacOccBitNetType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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