oaChangeMgr.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaChangeMgr.h
//
// This file contains the definitions for the oaChangeMgr class.
//
//  oaChangeMgr
//      Applications access CMS functionality through OpenAccess public API’s 
//      on the oaChangeMgr class. There are interfaces that provide the ability
//      to initialize change management tracking plug-ins, initialize export
//      plug-ins, start and stop change-management tracking, and export the
//      tracked changes.
//
//      The oaChangeMgr class delegates all operations to the tracking and 
//      export plug-ins. The tracking plug-in provides the mechanisms to create
//      and manage change sets. Change sets must be named by the application.
//
//      The current change set refers to the last change set that was created 
//      by the application. Change records will be created and placed in the
//      current change set if it has not been ended or closed.
//
// *****************************************************************************
// 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 2007 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #2 $
//  $Date: 2010/10/18 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaChangeMgr_P)
#define oaChangeMgr_P



// ****************************************************************************
// Nested includes
// ****************************************************************************
#include <map>
#include <string>
#include "oaCMBaseTypes.h"



// *****************************************************************************
// Declare names in the OA namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaCMProtocolArray;
class oaCMProtocol;
class oaChangeSetBase;
class oaString;
struct oaChangeMgrImpl;


// *****************************************************************************
// oaChangeMgr
// *****************************************************************************
class OA_CM_DLL_API oaChangeMgr {
public:
    typedef std::map<std::string, oaChangeSetBase*>::const_iterator ChangeSetConstIter;

    static oaChangeMgr                                              *get();

    void                                                            initTracking(const oaString &pluginName);
    void                                                            initExport(const oaString &pluginName);

    void                                                            getTrackingProtocols(oaCMProtocolArray &out) const;
    void                                                            getExportProtocols(oaCMProtocolArray &out) const;

    void                                                            setTrackingProtocol(const oaCMProtocol &in);
    void                                                            setExportProtocol(const oaCMProtocol &in);

    void                                                            beginTracking(const oaString &nameIn);
    void                                                            endTracking();

    void                                                            exportFull(const oaString &changeSetName);
    void                                                            exportIncr(const oaString &changeSetName);

    oaChangeSetBase                                                 *findChangeSet(const oaString &nameIn) const;
    void                                                            discardAllChangeSets();

    ChangeSetConstIter                                              beginChangeSet() const;
    ChangeSetConstIter                                              endChangeSet() const;

    void                                                            discardChangeSet(const oaString &changeSetName);

private:
                                                                    oaChangeMgr();
                                                                    ~oaChangeMgr();

    void                                                            add(const oaString  &changeSetName,
                                                                        oaChangeSetBase *changeSet);
    void                                                            remove(oaChangeSetBase *changeSet);

    mutable oaChangeMgrImpl                                         *m_data;

    friend class oaChangeSetBase;
};



END_OA_NAMESPACE

#endif

Return to top of page

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