oaViaHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaViaHeader.h
//
// This file contains the definition for the oaViaHeader class and its public 
// supporting classes.
//
//  oaViaHeader
//      This base class implements an object that contains information about a
//      particular viaDef and all of the vias that reference it. A viaHeader
//      is an automatic object that is created and destroyed by the database.
//      An oaViaHeader may be either a standard or custom viaHeader and is
//      associated with standard or custom vias, respectively.
//
//      A viaHeader is automatically created whenever the first via of a
//      viaDef is created. A viaHeader is destroyed when the last via
//      associated with the viaDef is destroyed.
//
//  oaStdViaHeader
//      This class implements a viaHeader that contains information about a
//      standard viaDef and all of the standard vias in a design that use it.
//      A standard via has a fixed number of parameters which can be set
//      using an oaViaParam object.
//
//  oaCustomViaHeader
//      This class implements a viaHeader that contains information about a
//      custom viaDef and all of the custom vias in a design that use it. A
//      custom via has a customizable set of parameters which can be set
//      using an oaParamArray object.
//
//
// *****************************************************************************
// 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(oaViaHeader_P)
#define oaViaHeader_P



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



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



// *****************************************************************************
// oaViaHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaViaHeader : public oaRefHeader {
public:
    static oaViaHeader                      *find(const oaBlock     *block,
                                                  const oaString    &viaDefName);
    static oaViaHeader                      *find(const oaBlock     *block,
                                                  const oaViaDef    *viaDef);

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

    oaCollection<oaVia, oaViaHeader>        getVias() const;
    oaCollection<oaViaHeader, oaViaHeader>  getSubHeaders() const;

    enum {dtIndex = oacViaHeaderDataType};
};



// *****************************************************************************
// oaStdViaHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaStdViaHeader : public oaViaHeader {
public:
    void                    getParams(oaViaParam &params) const;
};



// *****************************************************************************
// oaCustomViaHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaCustomViaHeader : public oaViaHeader {
public:
    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;
    void                    getParams(oaParamArray &params) const;
    void                    getAllParams(oaParamArray &params) const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaViaHeader> {
public:
    typedef oaRefHeader             parentType;
    typedef oaViaHeaderModTypeEnum  modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dtIndex = oacViaHeaderDataType};
    enum {dataTypeEnumVal = oacViaHeaderDataType};
    enum {abstractTypeEnumVal = oacViaHeaderType};
};

template<>
class oaTraits<oaStdViaHeader> {
public:
    typedef oaViaHeaderModTypeEnum  modTypeType;
    typedef oaViaHeader             parentType;
    enum {dtIndex = oacViaHeaderDataType};
    enum {dataTypeEnumVal = oacViaHeaderDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacStdViaHeaderType};
};

template<>
class oaTraits<oaCustomViaHeader> {
public:
    typedef oaViaHeaderModTypeEnum  modTypeType;
    typedef oaViaHeader             parentType;
    enum {dtIndex = oacViaHeaderDataType};
    enum {dataTypeEnumVal = oacViaHeaderDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacCustomViaHeaderType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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