oaViaVariant.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaViaVariant.h
//
// This file contains the definitions of the oaViaVariant class and its public
// supporting classes. These classes include:
//
//  oaViaVariant
//      This class is an abstract base for all types of viaVariants.
//
//  oaStdViaVariant
//      This class implements a standard via variant. 
//
//  oaCustomViaVariant
//      This class implements a custom via variant. 
//
// *****************************************************************************
// 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:  $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaViaVariant_P)
#define oaViaVariant_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaParam.h"
#include "oaViaDef.h"



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



// *****************************************************************************
// oaViaVariant
// *****************************************************************************
class OA_TECH_DLL_API oaViaVariant : public oaObject {
public:
    static oaViaVariant     *find(const oaObject    *owner,
                                  const oaString    &name,
                                  oaBoolean         local = false);

    void                    destroy();

    void                    getName(oaString &name) const;
    oaViaDef                *getViaDef() const;
    void                    getViaDefName(oaString &name) const;

    enum {dtIndex = oacBaseViaVariantDataType};
};



// *****************************************************************************
// oaStdViaVariant
// *****************************************************************************
class OA_TECH_DLL_API oaStdViaVariant : public oaViaVariant {
public:
    static oaStdViaVariant  *create(oaObject            *owner,
                                    const oaString      &name,
                                    const oaStdViaDef   *viaDef,
                                    const oaViaParam    &params);

    static oaStdViaVariant  *find(const oaObject    *owner,
                                  const oaStdViaDef *viaDef,
                                  const oaViaParam  &params,
                                  oaBoolean         local = false);

    void                    getParams(oaViaParam &params) const;
};



// *****************************************************************************
// oaCustomViaVariant
// *****************************************************************************
class OA_TECH_DLL_API oaCustomViaVariant : public oaViaVariant {
public:
    static oaCustomViaVariant   *create(oaObject                *owner,
                                        const oaString          &name,
                                        const oaCustomViaDef    *viaDef,
                                        const oaParamArray      &params);

    static oaCustomViaVariant   *find(const oaObject        *owner,
                                      const oaCustomViaDef  *viaDef,
                                      const oaParamArray    &params,
                                      oaBoolean             local = false);

    void                        getParams(oaParamArray &params) const;
};



// *****************************************************************************
// Tech Objects derived from oaObject
// *****************************************************************************
template<>
class oaTraits<oaViaVariant> {
public:
    typedef oaObject                parentType;
    typedef oaViaVariantModTypeEnum modTypeType;
    typedef oaViaVariantTbl         tblType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseViaVariantDataType};
    enum {dataTypeEnumVal = oacBaseViaVariantDataType};
    enum {abstractTypeEnumVal = oacViaVariantType};
};

template<>
class oaTraits<oaStdViaVariant> {
public:
    typedef oaViaVariantModTypeEnum modTypeType;
    typedef oaViaVariantTbl         tblType;
    typedef oaViaVariant            parentType;
    enum {dtIndex = oacBaseViaVariantDataType};
    enum {dataTypeEnumVal = oacBaseViaVariantDataType};
    enum {abstractTypeEnumVal = oacViaVariantType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacStdViaVariantType};
};

template<>
class oaTraits<oaCustomViaVariant> {
public:
    typedef oaViaVariantModTypeEnum modTypeType;
    typedef oaViaVariantTbl         tblType;
    typedef oaViaVariant            parentType;
    enum {dtIndex = oacBaseViaVariantDataType};
    enum {dataTypeEnumVal = oacBaseViaVariantDataType};
    enum {abstractTypeEnumVal = oacViaVariantType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacCustomViaVariantType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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