oaOccInstHeader.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccInstHeader.h
//
// This file contains the definition for the oaOccInstHeader class. The 
// oaOccInstHeader class implements an object that contains the occurrnece 
// domain view about a particular design master and all of the instances that
// use it. oaOccInstHeader objects are scoped within an owner occurrence.
//
// *****************************************************************************
// 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(oaOccInstHeader_P)
#define oaOccInstHeader_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaInstHeader.h"
#include "oaModInstHeader.h"
#include "oaOccurrence.h"



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



// *****************************************************************************
// oaOccInstHeader
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccInstHeader : public oaOccObject {
public:
    oaDesign                                        *getMaster() const;

    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;
    oaOccInstHeader                                 *getSuperHeader() const;

    oaBoolean                                       isBound() const;
    oaBoolean                                       isSuperHeader() const;
    oaBoolean                                       isSubHeader() const;

    oaInstHeader                                    *getInstHeader() const;
    oaModInstHeader                                 *getModInstHeader() const;

    oaCollection<oaOccDesignInst, oaOccInstHeader>  getInsts(oaUInt4        filterFlags = oacInstIterNotImplicit,
                                                             oaOccurrence   *parentOcc = NULL) const;
    oaCollection<oaOccInstHeader, oaOccInstHeader>  getSubHeaders() const;

    enum {dtIndex = oacInstHeaderDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccInstHeader> {
public:
    typedef oaOccObject             parentType;
    typedef oaInstHeaderModTypeEnum modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacInstHeaderDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccInstHeaderType};
    enum {dataTypeEnumVal = oacInstHeaderDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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