oaOccurrence.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccurrence.h
//
// This file contains the definition for the oaOccurrence class and its public
// supporting classes. The oaOccurrence class is the main object for storing 
// information about the occurrence level of hierarchy in a design. It 
// implements methods for accessing information within that occurrence. There 
// are zero or one top occurrence objects in a design. 

//
// *****************************************************************************
// 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(oaOccurrence_P)
#define oaOccurrence_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaModule.h"
#include "oaOccObject.h"



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



// *****************************************************************************
// oaOccurrence
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccurrence : public oaOccObject {
public:
    void                                                destroy();

    oaBlock                                             *getBlock() const;
    oaModule                                            *getModule() const;
    oaOccInst                                           *getOccInst() const;
    void                                                getTermsByPosition(oaOccTermArray &array) const;

    oaOccurrence                                        *uniquify();
    oaOccurrence                                        *uniquify(const oaScalarName &modName);

    oaCollection<oaOccAssignment, oaOccurrence>         getAssignments() const;
    oaCollection<oaOccBusNetDef, oaOccurrence>          getBusNetDefs() const;
    oaCollection<oaOccBusTermDef, oaOccurrence>         getBusTermDefs() const;
    oaCollection<oaOccConnectDef, oaOccurrence>         getConnectDefs() const;
    oaCollection<oaOccModuleInstHeader, oaOccurrence>   getModuleInstHeaders() const;
    oaCollection<oaOccInst, oaOccurrence>               getInsts(oaUInt4 filterFlags = oacInstIterNotImplicit) const;
    oaCollection<oaOccInstTerm, oaOccurrence>           getInstTerms(oaUInt4 filterFlags = oacInstTermIterNotImplicit) const;
    oaCollection<oaOccNet, oaOccurrence>                getNets(oaUInt4 filterFlags
                                                                = oacNetIterAll
                                                                | oacNetIterNotImplicit) const;
    oaCollection<oaOccTerm, oaOccurrence>               getTerms(oaUInt4 filterFlags
                                                                 = oacTermIterAllNotHidden
                                                                 | oacTermIterNotImplicit) const;
    oaCollection<oaOccVectorInstDef, oaOccurrence>      getVectorInstDefs() const;

    enum {dtIndex = oacOccurrenceDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccurrence> {
public:
    typedef oaOccObject             parentType;
    typedef oaOccurrenceModTypeEnum modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacOccurrenceDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccurrenceType};
    enum {dataTypeEnumVal = oacOccurrenceDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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