oaPoleResidue.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPoleResidue.h
//
// This file contains the definition for the oaPoleResidue class, which
// represents a set of poles and residues for a reduced model of the
// interconnect parasitics from a particular driver to a receiver on the net.
//
// *****************************************************************************
// 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(oaPoleResidue_P)
#define oaPoleResidue_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaComplex.h"
#include "oaDesignModTypes.h"
#include "oaDesignObject.h"



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



// *****************************************************************************
// oaPoleResidue
// *****************************************************************************
class OA_DESIGN_DLL_API oaPoleResidue : public oaDesignObject {
public:
    static oaPoleResidue    *create(oaPiPoleResidue                 *model,
                                    oaDesignObject                  *receiver,
                                    oaFloat                         delay,
                                    const oaComplexArray<oaFloat>   &poles,
                                    const oaComplexArray<oaFloat>   &residues);

    static oaPoleResidue    *find(const oaPiPoleResidue *model,
                                  const oaDesignObject  *receiver);

    void                    destroy();

    void                    setDelay(oaFloat delay);
    void                    setPoles(const oaComplexArray<oaFloat> &poles);
    void                    setResidues(const oaComplexArray<oaFloat> &res);

    oaFloat                 getDelay() const;
    void                    getPoles(oaComplexArray<oaFloat> &poles) const;
    void                    getResidues(oaComplexArray<oaFloat> &res) const;

    oaDesignObject          *getReceiver() const;
    oaPiPoleResidue         *getPiPoleResidue() const;

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



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



END_OA_NAMESPACE

#endif

Return to top of page

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