oaVia.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaVia.h
//
// This file contains the definitions of the oaVia class and its public
// supporting classes. These classes include:
//
//  oaViaDirection
//      The oaViaDirection class implements an enumerated type that describes
//      the direction of a via.
//
//  oaVia
//      This class is an abstract base for all types of vias. oaVia objects are
//      used for connecting two adjacent route segments (pathSegs) that are on
//      different layers. oaVia objects reference an oaViaDef defined in a
//      technology database.
//
//  oaStdVia
//      This class implements a standard via. A standard via uses a built in
//      model of a via, and refers to an oaStdViaDef that has a specific set of
//      parameters defined in an oaViaParam.
//
//  oaCustomVia
//      This class implements a custom via. A custom via uses a specified design
//      to represent a via, and refers to an oaCustomViaDef. The design may be
//      a parameterized cell.
//
// *****************************************************************************
// 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 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaVia_P)
#define oaVia_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaRef.h"
#include "oaViaHeader.h"



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



// *****************************************************************************
// oaViaDirectionEnum
// *****************************************************************************
#define oavNumViaDirectionTypes 2

enum oaViaDirectionEnum {
    oacLayer1ToLayer2ViaDirection   = 0,
    oacLayer2ToLayer1ViaDirection   = 1
};



// *****************************************************************************
// oaViaDirection
// *****************************************************************************
class OA_DESIGN_DLL_API oaViaDirection {
public:         
                            oaViaDirection(oaViaDirectionEnum valueIn);
                            oaViaDirection(const oaString &name);
                            ~oaViaDirection();

    const oaString          &getName() const;

                            operator                oaViaDirectionEnum() const;

private:
    oaViaDirectionEnum      value;

    static const oaString   names[];
};



// *****************************************************************************
// oaVia
// *****************************************************************************
class OA_DESIGN_DLL_API oaVia : public oaRef {
public:
    oaViaHeader                     *getHeader() const;
    oaViaDef                        *getViaDef() const;
    void                            getViaDefName(oaString &name) const;
    oaPurposeNum                    getPurposeNum() const;
    oaRoute                         *getRoute() const;
    oaRouteStatus                   getRouteStatus() const;
    oaRouteTopology                 getRouteTopology() const;
    oaViaDirection                  getDirection() const;
    oaBitNet                        *getShieldedNet1() const;
    oaBitNet                        *getShieldedNet2() const;
    oaBoolean                       isUnShielded() const;

    oaBoolean                       hasRoute() const;

    void                            setPurposeNum(oaPurposeNum purposeNum);
    void                            setRouteStatus(const oaRouteStatus &status);
    void                            setRouteTopology(const oaRouteTopology &topology);
    void                            setDirection(const oaViaDirection &dir);
    void                            setShieldedNet1(oaBitNet *net);
    void                            setShieldedNet2(oaBitNet *net);
    void                            setUnShielded(oaBoolean unShielded);

    oaCollection<oaRoute, oaVia>    getConnRoutes() const;

    enum {dtIndex = oacViaDataType};
};



// *****************************************************************************
// oaStdVia
// *****************************************************************************
class OA_DESIGN_DLL_API oaStdVia : public oaVia {
public:
    static oaStdVia         *create(oaBlock             *block,
                                    const oaStdViaDef   *viaDef,
                                    const oaTransform   &xform,
                                    const oaViaParam    *params = NULL);

    oaStdViaHeader          *getHeader() const;
    void                    getViaParams(oaViaParam &params) const;

    void                    setViaParams(const oaViaParam &params);
};



// *****************************************************************************
// oaCustomVia
// *****************************************************************************
class OA_DESIGN_DLL_API oaCustomVia : public oaVia {
public:
    static oaCustomVia      *create(oaBlock                 *block,
                                    const oaCustomViaDef    *viaDef,
                                    const oaTransform       &xform,
                                    const oaParamArray      *params = NULL);

    void                    getLibName(oaScalarName &libName) const;
    void                    getCellName(oaScalarName &cellName) const;
    void                    getViewName(oaScalarName &viewName) const;
    void                    getLibName(const oaNameSpace    &ns,
                                       oaString             &libName) const;
    void                    getCellName(const oaNameSpace   &ns,
                                        oaString            &cellName) const;
    void                    getViewName(const oaNameSpace   &ns,
                                        oaString            &viewName) const;
    oaCustomViaHeader       *getHeader() const;
    void                    getParams(oaParamArray &params) const;

    void                    setParams(const oaParamArray &params);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaVia> {
public:
    typedef oaRef               parentType;
    typedef oaViaModTypeEnum    modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dtIndex = oacViaDataType};
    enum {dataTypeEnumVal = oacViaDataType};
    enum {abstractTypeEnumVal = oacViaType};
};

template<>
class oaTraits<oaStdVia> {
public:
    typedef oaViaModTypeEnum    modTypeType;
    typedef oaVia               parentType;
    enum {dtIndex = oacViaDataType};
    enum {dataTypeEnumVal = oacViaDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacStdViaType};
};

template<>
class oaTraits<oaCustomVia> {
public:
    typedef oaViaModTypeEnum    modTypeType;
    typedef oaVia               parentType;
    enum {dtIndex = oacViaDataType};
    enum {dataTypeEnumVal = oacViaDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacCustomViaType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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