oaDMFile.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMFile.h
//
// This file contains the definition for the oaDMFile class and its public
// supporting classes. The oaDMFile class represents a managed file. The
// public supporting classes include:
//
// oaDMLockStatus
//
//     This class implements an enumerated type that describes the lock status.
//
// *****************************************************************************
// 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: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDMFile_P)
#define oaDMFile_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaDMModTypes.h"
#include "oaDMObject.h"
#include "oaSaveRecover.h"


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



// *****************************************************************************
// oaDMLockStatus
// *****************************************************************************
class OA_DM_DLL_API oaDMLockStatus {
public:
                            oaDMLockStatus(oaDMLockStatusEnum valueIn);

    const oaString          &getName() const;

                            operator                oaDMLockStatusEnum() const;

private:
    oaDMLockStatusEnum      value;

    static const oaString   names[];
};



// *****************************************************************************
// oaDMFile
// *****************************************************************************
class OA_DM_DLL_API oaDMFile : public oaDMObject {
public:
    static oaDMFile                     *find(const oaDMContainer   *parent,
                                              const oaString        &name);

    static oaDMFile                     *create(const oaDMContainer *parent,
                                                const oaString      &name,
                                                const oaString      &srcPath);
    static oaDMFile                     *create(const oaDMContainer *parent,
                                                const oaString      &name);

    void                                destroy();
    void                                destroy(oaSaveRecoverType type);

    oaDMContainer                       *getParent() const;
    void                                getName(oaString &name) const;
    void                                getPath(oaString &path) const;
    void                                getPath(oaSaveRecoverType   type,
                                                oaString            &path) const;
    oaDMFile                            *getLeader() const;

    oaBoolean                           isLeader() const;
    oaBoolean                           isPrimary() const;

    oaBoolean                           existsOnDisk() const;
    oaBoolean                           existsOnDisk(oaSaveRecoverType type) const;
    oaUInt8                             getOnDiskSize() const;

    void                                setLeader(oaDMFile *leader);

    oaBoolean                           getLock();
    void                                releaseLock();
    oaDMLockStatus                      getLockStatus() const;

    oaVCVersion                         getVersion() const;

    oaCollection<oaDMFile, oaDMFile>    getFollowers() const;

    enum {dtIndex = oacDMFileDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaDMFile> {
public:
    typedef oaDMObject          parentType;
    typedef oaDMFileModTypeEnum modTypeType;
    enum {dbType = oacLibDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacDMFileDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacDMFileType};
    enum {dataTypeEnumVal = oacDMFileDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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