oaParasiticNetwork.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaParasiticNetwork.h
//
// This file contains the definition for the oaParasiticNetwork class, which
// represents the parasitic elements for a particular net as a graph.
//
// *****************************************************************************
// 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 2002-2006 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaParasiticNetwork_P)
#define oaParasiticNetwork_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBox.h"
#include "oaAnalysisPoint.h"



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



// *****************************************************************************
// oaParasiticNetwork
// *****************************************************************************
class OA_DESIGN_DLL_API oaParasiticNetwork : public oaDesignObject {
public:
    static oaParasiticNetwork                               *create(oaDesignObject  *net,
                                                                    oaAnalysisPoint *ap);

    static oaParasiticNetwork                               *create(oaDesignObject              *net,
                                                                    const oaAnalysisPointArray  &aps);
#if !defined(OA_DEPRECATED)
    static oaParasiticNetwork                               *create(oaDesignObject  *net,
                                                                    oaUInt4         numAPs,
                                                                    oaAnalysisPoint **aps);
#endif

    static oaParasiticNetwork                               *create(oaParasiticNetwork *parent);
    static oaParasiticNetwork                               *create(oaParasiticNetwork  *parent,
                                                                    const oaString      &name);

    static oaParasiticNetwork                               *load(const oaDesignObject  *net,
                                                                  const oaAnalysisPoint *ap,
                                                                  oaBoolean             allPartitions = false);

    static oaParasiticNetwork                               *find(const oaDesignObject  *net,
                                                                  const oaAnalysisPoint *ap);

    static oaParasiticNetwork                               *find(const oaParasiticNetwork  *parent,
                                                                  const oaString            &name);

    static oaBoolean                                        exists(const oaDesignObject     *net,
                                                                   const oaAnalysisPoint    *ap);

    static void                                             destroy(oaDesignObject          *net,
                                                                    const oaAnalysisPoint   *ap);
    static void                                             destroy(oaDesign                *design,
                                                                    const oaAnalysisPoint   *ap);
    static void                                             destroy(oaDesignObject *net);
    static void                                             destroy(oaDesign *design);

    void                                                    load(oaBoolean allPartitions = false);

    void                                                    destroy();
    void                                                    unload();

    void                                                    setName(const oaString &name);
    void                                                    getName(oaString &name) const;

    void                                                    setBBox(const oaBox &bBox);
    void                                                    getBBox(oaBox &bBox) const;

    oaBoolean                                               isLoaded();
    oaBoolean                                               isParent();
    oaParasiticNetwork                                      *getParent();

    oaDomain                                                getDomain() const;
    oaDesignObject                                          *getNet() const;

    oaCollection<oaNode, oaParasiticNetwork>                getNodes() const;
    oaCollection<oaDevice, oaParasiticNetwork>              getDevices() const;
    oaCollection<oaAnalysisPoint, oaParasiticNetwork>       getAnalysisPoints() const;
    oaCollection<oaDesignObject, oaParasiticNetwork>        getCoupledNets() const;
    oaCollection<oaNode, oaParasiticNetwork>                getConnNodes(const oaDesignObject *conn) const;
    oaCollection<oaSubNetwork, oaParasiticNetwork>          getSubNetworks() const;
    oaCollection<oaParasiticNetwork, oaParasiticNetwork>    getPartitions() const;


    enum {dtIndex = oacParasiticNetworkDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaParasiticNetwork> {
public:
    typedef oaDesignObject                  parentType;
    typedef oaParasiticNetworkModTypeEnum   modTypeType;
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacParasiticNetworkDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacParasiticNetworkType};
    enum {dataTypeEnumVal = oacParasiticNetworkDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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