oaOccTraverser.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccTraverser.h
//
// This file contains the declaration for the oaOccTraverser class. This class
// implements a hierarchical traversal for connectivity objects in the
// occurrence domain. Capabilities it supports include:
//
// 1)   oaOccTraverser is not an abstract class. Applications can create their 
//      own sub-class in order to provide specific functionality.
// 2)   A traverse() method initiates the traversal.
// 3)   The flags() method and a set of flag bits enable the applications to
//      control the traversal.
// 4)   The virtual functions process*() inherited from the producer are called 
//      for connectivity objects of a specific type.
// 5)   The virtual function startInst() is called just before the contents of
//      an instance in the hierarchy are produced. The caller can override this
//      function, and return a boolean indicating whether or not the traversal 
//      should descend into the instance's master.The default implementation 
//      returns true, which means the traversal should descend into the 
//      instance's master.
// 6)   The virtual function endInst() is called just after the contents of
//      an instance's master in the hierarchy have been produced.
//
// *****************************************************************************
// 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-2010 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaOccTraverser_P)
#define oaOccTraverser_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaOccVectorInstDef.h"
#include "oaOccInstHeader.h"
#include "oaOccModuleInstHeader.h"
#include "oaOccBusNetDef.h"
#include "oaOccInstTerm.h"
#include "oaOccBusTermDef.h"
#include "oaOccConnectDef.h"
#include "oaOccAssignment.h"
#include "oaOccProducer.h"



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



// *****************************************************************************
// The following flag bits are used for the traversal control flag.
// *****************************************************************************
#define oavOccTraversePostOrderShift    0
#define oavOccTraverseDesignsShift      1
#define oavOccTraverseImplicitShift     2

#define oavOccTraversePostOrder         (1 << oavOccTraversePostOrderShift)
#define oavOccTraverseDesigns           (1 << oavOccTraverseDesignsShift)
#define oavOccTraverseImplicit          (1 << oavOccTraverseImplicitShift)

#define oavOccTraverseDefault           0



// *****************************************************************************
// oaOccTraverser
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccTraverser : public oaOccProducer {
public:
                            oaOccTraverser(oaOccurrence *topOcc);
                            ~oaOccTraverser();

    oaUInt4                 &flags();

    const oaOccurrence      *getTopOccurrence() const;

    void                    traverse();
    void                    abort();

    virtual oaBoolean       startInst(oaOccInst *inst);
    virtual void            endInst(oaOccInst *inst);
    virtual oaBoolean       startOccurrence(oaOccurrence *occ);
    virtual void            endOccurrence(oaOccurrence *occ);

private:
    oaUInt4                 flagsVal;
};




END_OA_NAMESPACE

#endif

Return to top of page

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