oaCMObserver.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCMObserver.h
//
// This file contains the definition for those oaCM classes that require
// specialization of the generic oaVersionedObserver template.
//
// *****************************************************************************
// 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 2002-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: davidy $
//  $Revision: #1 $
//  $Date: 2007/06/11 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaCMObserver_P)
#define oaCMObserver_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCMBaseTypes.h"
#include "oaCMModTypes.h"
#include "oaObserver.h"



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



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaChangeMgr;
class oaChangeSetBase;



// *****************************************************************************
// oaVersionedObserver<oaChangeMgr> specialization
// *****************************************************************************
// <TM> Added to make these observers show up. The actual header file is at
// \oa\src\cm\oaCMObserver.h
template<>
class OA_CM_DLL_API oaVersionedObserver<oaChangeMgr> : public oaBaseObserver {//Removed ", oaRevisionTraits<oaChangeMgr>::scopedObserverRevision"
public:
                                                                    oaVersionedObserver(oaUInt4     priorityIn,
                                                                                        oaBoolean   enabledIn = true);
    virtual                                                         ~oaVersionedObserver();

    virtual void                                                    onInvalidate(oaChangeMgrModTypeEnum modType);
    virtual void                                                    onPreImport();
    virtual void                                                    onPostImport();
    virtual void                                                    onPreExport();
    virtual void                                                    onPostExport();
/* <JR> Dell does not want these doc'd.
    static oaBoolean                                                hasObservers();
    static void                                                     notifyInvalidateObservers(oaChangeMgrModTypeEnum modType);
    static void                                                     notifyPreImportObservers();
    static void                                                     notifyPostImportObservers();
    static void                                                     notifyPreExportObservers();
    static void                                                     notifyPostExportObservers();
*/
private:
    typedef oaVersionedObserver<oaChangeMgr, oaRevisionTraits<oaChangeMgr>::scopedObserverRevision>   oaChangeMgrObserver;

    oaChangeMgrObserver                                             *next;

    static oaChangeMgrObserver                                      *first;
};



// *****************************************************************************
// oaChangeSetObserver
// *****************************************************************************
class OA_CM_DLL_API oaChangeSetObserver {
public:
                            oaChangeSetObserver(oaUInt4     priorityIn,
                                                oaBoolean   enabledIn = true);
    virtual                 ~oaChangeSetObserver();

    virtual void            onPostCreate(oaChangeSetBase *cs);
    virtual void            onPreDestroy(oaChangeSetBase *cs);
    virtual void            onEmpty(oaChangeSetBase *cs);
    virtual void            onFirstChange(oaChangeSetBase *cs);
    virtual void            onFullExport(oaChangeSetBase    *cs);
    virtual void            onIncrementalExport(oaChangeSetBase *cs);

    oaBoolean               isEnabled();
    void                    enable(oaBoolean enabled);
    oaUInt4                 getPriority() const;

/* This does not need to be doc'd.
private:
    void                    *m_pImpl;
*/
};



END_OA_NAMESPACE

#endif

Return to top of page

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