oaMutualInductor.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaMutualInductor.h
//
// This file contains the definition of the oaMutualInductor class, which
// represents the mutual inductance between two inductor devices. The two
// inductors may be within the same parasitic network or within the parasitic
// networks for two different 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaMutualInductor_P)
#define oaMutualInductor_P



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



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



// *****************************************************************************
// oaMutualInductor
// *****************************************************************************
class OA_DESIGN_DLL_API oaMutualInductor : public oaDevice {
public:
    static oaMutualInductor *create(oaInductor  *fromInductor,
                                    oaInductor  *toInductor);
    static oaMutualInductor *create(oaInductor  *fromInductor,
                                    oaInductor  *toInductor,
                                    oaUInt4     id);
    static oaMutualInductor *create(oaInductor      *fromInductor,
                                    oaDesignObject  *otherNet,
                                    oaUInt4         otherInductorId,
                                    oaUInt4         id);

    oaBoolean               isLocal() const;

    void                    setValue(const oaAnalysisPoint  *ap,
                                     oaFloat                value);
    oaFloat                 getValue(const oaAnalysisPoint *ap) const;

    oaInductor              *getInductor(oaEndpointType endpoint) const;
    oaInductor              *getOtherInductor(oaInductor *inductor) const;
    void                    getOtherInductor(oaDesignObject *&otherNet,
                                             oaUInt4        &otherInductorId) const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaMutualInductor> {
public:
    typedef oaDeviceModTypeEnum modTypeType;
    typedef oaDevice            parentType;
    enum {dtIndex = oacDeviceDataType};
    enum {dataTypeEnumVal = oacDeviceDataType};
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacMutualInductorType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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