oaOccProducer.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccProducer.h
//
// This file contains the declaration for the oaOccProducer class. This class
// implements an occurrence producer for connectivity objects in the
// occurrence domain. Capabilities it supports include:
//
//   * a virtual produce() method initiates the producer. Overriding the produce
// function in a derivation class will enable custom ordering for the process*()
// set of functions.
//   * header filtering by overriding the startInstHeader or 
//     startModuleInstHeader set of functions
//   * the virtual functions process*() are called 
//     for connectivity objects of a specific type. Applications deriving from
//     the oaOccProducer class will need to override a subset of the process*()
//     set of functions. 
// *****************************************************************************
// 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 2009-2009 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: rursu $
//  $Revision: #7 $
//  $Date: 2008/08/29 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaOccProducer_P)
#define oaOccProducer_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"



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



// *****************************************************************************
// oaOccProducer
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccProducer {
public:
                            oaOccProducer(oaOccurrence *occ);
    virtual                 ~oaOccProducer();
    
    oaOccurrence *          getOccurrence();
    void                    setOccurrence(oaOccurrence *occ);

    virtual void            produce();

    virtual void            processOccurrence(oaOccurrence *occ);
    virtual void            processInst(oaOccInst *inst);
    virtual void            processNet(oaOccNet *net);
    virtual void            processBusNetDef(oaOccBusNetDef *def);
    virtual void            processTerm(oaOccTerm *term);
    virtual void            processBusTermDef(oaOccBusTermDef *def);
    virtual void            processInstTerm(oaOccInstTerm *instTerm);
    virtual void            processVectorInstDef(oaOccVectorInstDef *def);
    virtual void            processInstHeader(oaOccInstHeader *ih);
    virtual void            processModuleInstHeader(oaOccModuleInstHeader *modIH);
    virtual void            processAssignment(oaOccAssignment *assign);
    virtual void            processConnectDef(oaOccConnectDef *connectDef);

    virtual oaBoolean       startInstHeader(oaOccInstHeader *ih);
    virtual void            endInstHeader(oaOccInstHeader *ih);
    virtual oaBoolean       startModuleInstHeader(oaOccModuleInstHeader *modIH);
    virtual void            endModuleInstHeader(oaOccModuleInstHeader *modIH);

protected:
    void                    produceInsts();
    void                    produceNets();
    void                    produceBusNetDefs();
    void                    produceTerms();
    void                    produceBusTermDefs();
    void                    produceInstTerms();
    void                    produceVectorInstDefs();
    void                    produceInstHeaders();
    void                    produceModuleInstHeaders();
    void                    produceAssignments();
    void                    produceConnectDefs();

    oaOccTraverserPvt       *prod;
};



END_OA_NAMESPACE

#endif

Return to top of page

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