oaDMObject.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMObject.h
//
// This file contains the definitions for the oaDMObject and oaDMContainer
// object classes, and their public supporting classes.  The oaDMObject class is
// an abstract base for all OpenAccess DM objects. The oaDMContainer class is
// the base for all classes which are file containers. The public supporting
// classes include:
//
//  oaDMTransType
//     This is a utility class which indicates the DM transaction type - read or
//     write.
//
// *****************************************************************************
// 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(oaDMObject_P)
#define oaDMObject_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaNativeNS.h"
#include "oaCollection.h"
#include "oaVCSystem.h"
#include "oaVCQueryDepth.h"



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



// *****************************************************************************
// oaDMObject
// *****************************************************************************
class OA_DM_DLL_API oaDMObject : public oaObject {
public:
    oaBoolean               isContainer() const;

    oaLib                   *getLib() const;
    void                    getTempFile(oaString    &path,
                                        oaBoolean   sameFileSystem = false) const;

    oaUInt4                 getVCStatus(oaUInt4 mask = oacVCStatusAll) const;

    oaVCVersionIter         getVersions() const;

    void                    update(const oaVCVersion    &version,
                                   oaBoolean            recurse = true,
                                   const oaChar         *options = NULL);

    void                    makeEditable(oaBoolean      lock,
                                         oaBoolean      recurse = true,
                                         const oaChar   *options = NULL);
    void                    cancelEdit(oaBoolean    recurse = true,
                                       const oaChar *options = NULL);
    void                    commitEdits(const oaChar    *comment,
                                        oaBoolean       recurse = true,
                                        oaBoolean       keepEditable = false,
                                        const oaChar    *options = NULL);

    void                    setControlled(oaBoolean     recurse = true,
                                          const oaChar  *options = NULL);
    void                    unsetControlled(oaBoolean       recurse = true,
                                            oaBoolean       keepLocalRep = true,
                                            const oaChar    *options = NULL);

    enum {dbType = oacLibDBType};
};



// *****************************************************************************
// oaDMObjectStatusRef
// *****************************************************************************
class OA_DM_DLL_API oaDMObjectStatusRef {
public:
                            oaDMObjectStatusRef(oaDMObject  *obj = NULL,
                                                oaUInt4     stat = 0);
    oaDMObject              *&getObject();
    oaDMObject              *getObject() const;

    oaUInt4                 &getStatus();
    oaUInt4                 getStatus() const;

private:
    oaDMObject              *object;
    oaUInt4                 status;
};



// *****************************************************************************
// oaDMObjectVersionRef
// *****************************************************************************
class OA_DM_DLL_API oaDMObjectVersionRef {
public:
                            oaDMObjectVersionRef(const oaDMObject   *obj,
                                                 const oaVCVersion  &ver);
                            oaDMObjectVersionRef(const oaDMObject *obj = NULL);

    const oaDMObject        *&getObject();
    const oaDMObject        *getObject() const;

    oaVCVersion             &getVersion();
    oaVCVersion             getVersion() const;

private:
    const oaDMObject        *object;
    oaVCVersion             version;
};



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

    oaDMObjectVersionRefIter    &operator=(const oaDMObjectVersionRefIter &iter);

    oaDMObjectVersionRef        getNext();
    void                        reset();

private:
    void                        *data;
};



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

    oaDMObjectIter          &operator=(const oaDMObjectIter &iter);
    oaDMObject              *getNext();
    void                    reset();

private:
    void                    *data;
};



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

    oaDMObjectStatusRef     getNext();
    void                    reset();

private:
    void                    *data;

    static oaNativeNS       ns;
};



// *****************************************************************************
// oaDMContainer
// *****************************************************************************
class OA_DM_DLL_API oaDMContainer : public oaDMObject {
public:
    oaCollection<oaDMFile, oaDMContainer>   getDMFiles() const;

    using                   oaDMObject::getVCStatus;
    oaDMObjectStatusRefIter                 getVCStatus(oaVCQueryDepth  depth,
                                                        oaUInt4         mask = oacVCStatusAll) const;
};



// *****************************************************************************
// oaDMObject is the base for the DM Objects
// *****************************************************************************
template<>
class oaTraits<oaDMObject> {
public:
    typedef oaObject        parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacLibDBType};
    enum {abstractTypeEnumVal = oacDMObjectType};
};

template<>
class oaTraits<oaDMContainer> {
public:
    typedef oaDMObject      parentType;
    enum {dbType = oacLibDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacDMContainerType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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