oaVCSystem.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaVCSystem.h
//
// This file contains the definition for the oaVCSystem class and classes
// assiciated with the version control API.
//
// oaVCSystem
//      This class is used to manage and access version control plug-ins through
//      the OA public interface.
//
// oaVCVersion
//      This class manages an IVersion interface pointer as an abstraction for
//      the OA public API. The real work is done by a derived oaVCVersionPvt
//      class to prevent dependencies from the OA public API on the plug-in
//      interfaces.
//
// *****************************************************************************
// 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-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaVCSystem_P)
#define oaVCSystem_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"
#include "oaVCCap.h"
#include "oaVersionComp.h"



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



// *****************************************************************************
// oaVCSystem
// *****************************************************************************
class OA_DM_DLL_API oaVCSystem {
public:
    static oaVCSystem       *get(const oaChar *name);
    void                    destroy();

    virtual void            getName(oaString &name) const = 0;

    virtual oaBoolean       testCapability(oaVCCap cap) const = 0;
    virtual oaBoolean       getControlledLibs(oaArray<oaLib*> &libs) const = 0;

protected:
    virtual                 ~oaVCSystem();
};



// *****************************************************************************
// oaVCVersion
// *****************************************************************************
class OA_DM_DLL_API oaVCVersion {
public:
                            oaVCVersion();
                            oaVCVersion(const oaChar    *sysName,
                                        const oaChar    *displayName = NULL);
                            oaVCVersion(const oaVCVersion &ver);
                            oaVCVersion(void *versionData);
                            ~oaVCVersion();

    void                    getVCSystemName(oaString &sysName) const;
    void                    setDisplayName(const oaChar *sysName,
                                           const oaChar *displayName);
    void                    getDisplayName(oaString &name) const;
    oaVersionComp           compare(const oaVCVersion *other) const;

    oaVCVersion             &operator=(const oaVCVersion &ver);

    void                    *getRaw() const;

private:
    void                    *version;
};



// *****************************************************************************
// oaVCVersionIter
// *****************************************************************************
class OA_DM_DLL_API oaVCVersionIter {
public:
                            oaVCVersionIter(const oaVCVersionIter &iter);
                            oaVCVersionIter(void *data);
                            ~oaVCVersionIter();
    oaVCVersionIter         &operator=(const oaVCVersionIter &iter);


    oaVCVersion             getNext();
    void                    reset();

private:
    void                    *data;
};



END_OA_NAMESPACE

#endif

Return to top of page

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