oaSeriesRL.h

Go to the documentation of this file.
00001 // *****************************************************************************
00002 // *****************************************************************************
00003 // oaSeriesRL.h
00004 //
00005 // This file contains the definition of the oaSeriesRL class, which represents
00006 // a resistor and an inductor connected in series within a parasitic network
00007 // for a net, where the node between the two devices is not of interest.
00008 //
00009 // *****************************************************************************
00010 // Except as specified in the OpenAccess terms of use of Cadence or Silicon
00011 // Integration Initiative, this material may not be copied, modified,
00012 // re-published, uploaded, executed, or distributed in any way, in any medium,
00013 // in whole or in part, without prior written permission from Cadence.
00014 //
00015 //                Copyright 2002-2005 Cadence Design Systems, Inc.
00016 //                           All Rights Reserved.
00017 //
00018 //  $Author: icftcm $
00019 //  $Revision: #1 $
00020 //  $Date: 2010/08/09 $
00021 //  $State: Exp $
00022 // *****************************************************************************
00023 // *****************************************************************************
00024 
00025 
00026 
00027 #if !defined(oaSeriesRL_P)
00028 #define oaSeriesRL_P
00029 
00030 
00031 
00032 // *****************************************************************************
00033 // Nested includes
00034 // *****************************************************************************
00035 #include "oaAnalysisPoint.h"
00036 #include "oaNode.h"
00037 #include "oaDevice.h"
00038 
00039 
00040 
00041 // *****************************************************************************
00042 // Declare and define types in the OpenAccess namespace.
00043 // *****************************************************************************
00044 BEGIN_OA_NAMESPACE
00045 
00046 
00047 
00048 // *****************************************************************************
00049 // oaSeriesRL
00050 // *****************************************************************************
00051 class OA_DESIGN_DLL_API oaSeriesRL : public oaDevice {
00052 public:
00053     static oaSeriesRL       *create(oaNode  *fromNode,
00054                                     oaNode  *toNode);
00055     static oaSeriesRL       *create(oaNode  *fromNode,
00056                                     oaNode  *toNode,
00057                                     oaUInt4 id);
00058 
00059     oaNode                  *getNode(oaEndpointType endpoint) const;
00060     oaNode                  *getOtherNode(oaNode *node) const;
00061     oaEndpointType          getEndpoint(oaNode *node) const;
00062 
00063     void                    setValue(const oaAnalysisPoint  *ap,
00064                                      oaFloat                resistance,
00065                                      oaFloat                inductance);
00066     void                    getValue(const oaAnalysisPoint  *ap,
00067                                      oaFloat                &resistance,
00068                                      oaFloat                &inductance) const;
00069 };
00070 
00071 
00072 
00073 // *****************************************************************************
00074 // Design Traits.
00075 // *****************************************************************************
00076 template<>
00077 class oaTraits<oaSeriesRL> {
00078 public:
00079     typedef oaDeviceModTypeEnum modTypeType;
00080     typedef oaDevice            parentType;
00081     enum {dtIndex = oacDeviceDataType};
00082     enum {dataTypeEnumVal = oacDeviceDataType};
00083     enum {dbType = oacDesignDBType};
00084     enum {domain = oacNoDomain};
00085     enum {isMultiDomain = false};
00086     enum {isConcrete = true};
00087     enum {objectTypeEnumVal = oacSeriesRLType};
00088 };
00089 
00090 
00091 
00092 END_OA_NAMESPACE
00093 
00094 #endif

Return to top of page