oaLib.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaLib.h
//
// This file contains the definition for the oaLib class and its public
// supporting classes. The oaLib class implements an DM managed library. The
// public supporting classes include:
//
//  oaLibMode
//      This enum wrapper class encapsulates the modes which are available for
// accessing a library.
//
//  oaLibAccess
//     This is a utility class which indicates the library access type which
// is used to obtain library access. There are two values: read and write.
//
//  oaLibAccessLevel
//     This is a utility class which indicates the current library access level.
// There are three levels: read, write, and none.
//
// *****************************************************************************
// 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-2007 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaLib_P)
#define oaLib_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaGroupDef.h"
#include "oaDMAttribute.h"
#include "oaDMObject.h"



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



// *****************************************************************************
// oaLibMode
// *****************************************************************************
class OA_DM_DLL_API oaLibMode {
public:
                            oaLibMode(oaLibModeEnum valueIn);
                            oaLibMode(const oaString &name);
                            ~oaLibMode();

    const oaString          &getName() const;

                            operator                oaLibModeEnum() const;

private:
    oaLibModeEnum           value;

    static const oaString   names[];
};



// *****************************************************************************
// oaLibAccess
// *****************************************************************************
class OA_DM_DLL_API oaLibAccess {
public:
                            oaLibAccess(oaLibAccessEnum valueIn);
                            oaLibAccess(const oaString &name);

    const oaString          &getName() const;

                            operator                oaLibAccessEnum() const;

private:
    oaLibAccessEnum         value;

    static const oaString   names[];
};



// *****************************************************************************
// oaLibAccessLevel
// *****************************************************************************
class OA_DM_DLL_API oaLibAccessLevel {
public:
                            oaLibAccessLevel(oaLibAccessLevelEnum valueIn);
                            oaLibAccessLevel(const oaString &name);

    const oaString          &getName() const;

                            operator                oaLibAccessLevelEnum() const;

private:
    oaLibAccessLevelEnum    value;

    static const oaString   names[];
};



// *****************************************************************************
// oaLib
// *****************************************************************************
class OA_DM_DLL_API oaLib : public oaDMContainer {
public:
    static oaLib                        *create(const oaScalarName  &name,
                                                const oaString      &libPath,
                                                oaLibMode           mode = oacSharedLibMode,
                                                const oaString      &dmSystem = "oaDMSystem",
                                                const oaDMAttrArray *dmAttrList = NULL);

    static oaLib                        *open(const oaScalarName    &name,
                                              const oaString        &libPath,
                                              const oaString        &writePath = "",
                                              oaLibMode             mode = oacSharedLibMode);

    static oaLib                        *find(const oaScalarName &name);

    static oaBoolean                    exists(const oaString &libPath);

    void                                close();

    void                                getName(oaScalarName &name) const;
    void                                getName(const oaNameSpace   &ns,
                                                oaString            &out) const;

    void                                getPath(oaString &path) const;
    void                                getFullPath(oaString &fullPath) const;
    void                                getWritePath(oaString &writePath) const;
    oaLibMode                           getMode() const;
    void                                getDMSystemName(oaString &dmSystem) const;
    void                                getAttributes(oaDMAttrArray &attrs) const;

    oaBoolean                           isReadable() const;
    oaBoolean                           isWritable() const;
    oaBoolean                           isMarkedToBeClosed() const;

    void                                setAttributes(const oaDMAttrArray &attrs);

    oaBoolean                           getAccess(oaLibAccess   accessType,
                                                  oaUInt4       timeout = 0);
    void                                releaseAccess();
    oaLibAccessLevel                    getAccessLevel() const;

    oaBoolean                           hasVC() const;

    oaUInt8                             calcVMSize() const;

    oaDMObjectIter                      getControlledObjects(oaVCQueryDepth depth = oacCellViewFileVCQueryDepth,
                                                             oaDMObject     *top = NULL,
                                                             oaBoolean      localOnly = false);

    oaDMObjectVersionRefIter            getWorkingVersions(oaVCQueryDepth depth = oacCellViewFileVCQueryDepth) const;

    oaCollection<oaCell, oaLib>         getCells() const;
    oaCollection<oaView, oaLib>         getViews() const;
    oaCollection<oaView, oaLib>         getViewsByName(const oaScalarName &name) const;
    oaCollection<oaCellView, oaLib>     getCellViews() const;

    oaCollection<oaGroup, oaLib>        getGroups() const;
    oaCollection<oaGroup, oaLib>        getGroups(oaGroupDef *def) const;
    oaCollection<oaGroup, oaLib>        getGroupsByName(const oaString &name) const;

    static oaCollection<oaLib, oaLib>   getOpenLibs();

    enum {dtIndex = oacLibDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaLib> {
public:
    typedef oaDMContainer   parentType;
    enum {dbType = oacLibDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacLibDataType};
    enum {dataTypeEnumVal = oacLibDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacLibType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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