oaPlugInCMInterfaces.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPlugInCMInterfaces.h
//
// This file contains the definitions for Change Management System interface
// classes. These include:
//
//  ICMPlugInBase
//      This is an abstract base class which defines the common interfaces for
//      all Change Management System plug-ins. These interfaces are to support
//      the initialization of the plug-in and to get the array of protocols the
//      plug-in supports.
//
//  ITracking
//      This class defines the interface to the Change Management System 
//      Tracking plug-in. There are interfaces to begin and end the tracking
//      services.
//
//  IExport
//      This class defines the interface to the Change Management System Export
//      plug-in. It supports an interface to export a full or incremental change
//      set using the specified protocol.
//
//
// *****************************************************************************
// 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: #1 $
//  $Date: 2007/03/20 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPlugInCMInterfaces_P)
#define oaPlugInCMInterfaces_P



// *****************************************************************************
// Nested Includes
// *****************************************************************************
#include "oaPlugInTypes.h"
#include "oaCommonIBase.h"



// *****************************************************************************
// Forward Declarations
// *****************************************************************************
BEGIN_OA_NAMESPACE
class oaString;
class oaChangeSetBase;
class oaCMProtocol;
class oaCMProtocolArray;
END_OA_NAMESPACE



// *****************************************************************************
// Define names in the OA_PLUGIIN namespace.
// *****************************************************************************
BEGIN_OA_PLUGIN_NAMESPACE



// *****************************************************************************
// ICMPlugInBase
// *****************************************************************************
class OA_PLUGIN_DLL_API ICMPlugInBase : public oaCommon::IBase {
public:
    virtual                 ~ICMPlugInBase();
    virtual void            init() = 0;
    virtual void            getProtocols(oa::oaCMProtocolArray &out) const = 0;
    virtual void            setProtocol(const oa::oaCMProtocol &in) = 0;
    virtual void            discardChangeSet(oa::oaChangeSetBase *in) = 0;
};



// *****************************************************************************
// ITracking
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ITracking;

class OA_PLUGIN_DLL_API ITracking : public ICMPlugInBase {
public:
    virtual                 ~ITracking();
    virtual void            beginTracking(const oa::oaString &name) = 0;
    virtual void            endTracking() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ITrackingIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ITrackingIter;
typedef IIter<ITracking*, &IID_ITrackingIter> ITrackingIter;



// *****************************************************************************
// IExport
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IExport;

class OA_PLUGIN_DLL_API IExport : public ICMPlugInBase {
public:
    virtual                 ~IExport();
    virtual void            exportFull(oa::oaChangeSetBase *changeSet) = 0;
    virtual void            exportIncr(oa::oaChangeSetBase *changeSet) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IExportIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IExportIter;
typedef IIter<IExport*, &IID_IExportIter> IExportIter;



END_OA_PLUGIN_NAMESPACE

#endif

Return to top of page

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