oaCouplingCap.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCouplingCap.h
//
// This file contains the definition of the oaCouplingCap class, which
// represents a coupling capacitor between two nodes in a parasitic network for
// a net, or between nodes in 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(oaCouplingCap_P)
#define oaCouplingCap_P



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



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



// *****************************************************************************
// oaCouplingCap
// *****************************************************************************
class OA_DESIGN_DLL_API oaCouplingCap : public oaStdDevice {
public:
    static oaCouplingCap    *create(oaNode  *fromNode,
                                    oaNode  *toNode);
    static oaCouplingCap    *create(oaNode  *fromNode,
                                    oaNode  *toNode,
                                    oaUInt4 id);
    static oaCouplingCap    *create(oaNode          *fromNode,
                                    oaDesignObject  *otherNet,
                                    oaUInt4         otherNodeId,
                                    oaUInt4         id);
    static oaCouplingCap    *create(oaNode          *fromNode,
                                    oaDesignObject  *otherConn,
                                    oaUInt4         id);

    oaBoolean               isLocal() const;
    oaBoolean               isOtherConn() const;

    oaNode                  *getNode(oaEndpointType endpoint) const;
    oaNode                  *getOtherNode(oaNode *node) const;
    void                    getOtherNode(oaDesignObject *&otherNet,
                                         oaUInt4        &otherNodeId) const;
    oaDesignObject          *getOtherConn() const;
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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