oaOccInst.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccInst.h
//
// This file contains the definition for the oaOccInst class and its public
// supporting classes. The oaOccInst class is an abstract base class for 
// occurrence instances of either design or embedded module master in the 
// 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(oaOccInst_P)
#define oaOccInst_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaInst.h"
#include "oaModInst.h"
#include "oaOccurrence.h"



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



// *****************************************************************************
// oaOccInst
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccInst : public oaOccObject {
public:
    static oaOccInst                            *find(const oaOccurrence    *occurrence,
                                                      const oaSimpleName    &name);

    oaOccurrence                                *getMasterOccurrence(oaBoolean expand = true) const;

    void                                        getName(oaSimpleName &name) const;
    void                                        getName(const oaNameSpace   &ns,
                                                        oaString            &name) const;

    void                                        getPathName(oaSimpleName &pathName) const;
    void                                        getPathName(const oaNameSpace   &ns,
                                                            oaString            &pathName) const;

    oaInst                                      *getInst() const;
    oaModInst                                   *getModInst() const;

    oaUInt4                                     getNumBits() const;

    oaBoolean                                   isBound() const;
    oaBoolean                                   isImplicit() const;
    oaBoolean                                   isOccDesignInst() const;
    oaBoolean                                   isOccModuleInst() const;
    oaBoolean                                   usesTermPositions() const;

    oaCollection<oaOccInstTerm, oaOccInst>      getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaOccAssignment, oaOccInst>    getAssignments() const;

    enum {dtIndex = oacInstDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccInst> {
public:
    typedef oaOccObject         parentType;
    typedef oaInstModTypeEnum   modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {dtIndex = oacInstDataType};
    enum {dataTypeEnumVal = oacInstDataType};
    enum {abstractTypeEnumVal = oacOccInstType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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