oaPiPoleResidue.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPiPoleResidue.h
//
// This file contains the definition for the oaPiPoleResidue class. The
// oaPiPoleResidue class represents a reduced model for the parasitics seen by a
// driver of a net using a PI model. The PI model consists of two capacitors and
// a resistor between them, with nearCap being the capacitor closer to the
// driver. For each receiver, the oaPiPoleResidue class models the interconnect
// between the driver and the receiver by a set of poles and residues.
//
// *****************************************************************************
// 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-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPiPoleResidue_P)
#define oaPiPoleResidue_P



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



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



// *****************************************************************************
// oaPiPoleResidue
// *****************************************************************************
class OA_DESIGN_DLL_API oaPiPoleResidue : public oaReducedModel {
public:
    static oaPiPoleResidue                          *create(oaDesignObject          *driver,
                                                            const oaAnalysisPoint   *ap,
                                                            oaFloat                 nearCap,
                                                            oaFloat                 res,
                                                            oaFloat                 farCap);

    static oaPiPoleResidue                          *find(const oaDesignObject  *driver,
                                                          const oaAnalysisPoint *ap);

    void                                            setNearCap(oaFloat value);
    void                                            setRes(oaFloat value);
    void                                            setFarCap(oaFloat value);
    void                                            setPiModel(oaFloat  nearCap,
                                                               oaFloat  res,
                                                               oaFloat  farCap);

    oaFloat                                         getNearCap() const;
    oaFloat                                         getRes() const;
    oaFloat                                         getFarCap() const;
    void                                            getPiModel(oaFloat  &nearCap,
                                                               oaFloat  &res,
                                                               oaFloat  &farCap) const;

    oaCollection<oaPoleResidue, oaPiPoleResidue>    getPoleResidues() const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaPiPoleResidue> {
public:
    typedef oaReducedModTypeEnum    modTypeType;
    typedef oaReducedModel          parentType;
    enum {dtIndex = oacReducedModelDataType};
    enum {dataTypeEnumVal = oacReducedModelDataType};
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPiPoleResidueType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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