oaLibDefListMem.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaLibDefListMem.h
//
// This file contains the definition for the oaLibDefListMem class and the
// derived classes oaLibDef and oaLibDefListRef.
//
//  oaLibDefListMem
//      This is the base class which implements a member in an oaLibDefList.
//      Members of the oaLibDefList can be moved about in the list as well as
//      being destroyed (and thus removed) from the list.
//
//  oaLibDef
//      The oaLibDef class derives from oaLibDefListMem and implements the
//      definition of a library in an owning oaLibDefList. A library definition
//      maps a logical library name to a physical file/directory path and
//      supports associating attributes to the definition.
//
//  oaLibDefListRef
//      The oaLibDefListRef derives from oaLibDefListMem and implements a
//      reference to another library definition list inside of an owning
//      oaLibDefList.
//
// *****************************************************************************
// 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(oaLibDefListMem_P)
#define oaLibDefListMem_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaLib.h"
#include "oaLibDefList.h"



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



// *****************************************************************************
// Forward class declaration
// *****************************************************************************
class oaDMAttrArray;



// *****************************************************************************
// oaLibDefListMem
// *****************************************************************************
class OA_DM_DLL_API oaLibDefListMem : public oaSessionObject {
public:
    oaLibDefList            *getList() const;

    void                    moveAfter(oaLibDefListMem *member);
    void                    moveToFirst();
    void                    moveToLast();

    void                    destroy();
};



// *****************************************************************************
// oaLibDef
// *****************************************************************************
class OA_DM_DLL_API oaLibDef : public oaLibDefListMem {
public:
    static oaLibDef         *create(oaLibDefList        *defList,
                                    const oaScalarName  &libName,
                                    const oaString      &libPath,
                                    const oaString      &writePath = "",
                                    oaLibMode           libMode = oacSharedLibMode,
                                    const oaDMAttrArray *libAttrs = NULL,
                                    oaLibDefListMem     *followingMem = NULL);

    static oaLibDef         *find(const oaLibDefList    *defList,
                                  const oaScalarName    &libName);

    void                    getLibName(oaScalarName &libName) const;
    void                    getLibPath(oaString &path) const;

    void                    getLibWritePath(oaString &writePath) const;
    void                    setLibWritePath(const oaString &writePath);

    oaLibMode               getLibMode() const;
    void                    setLibMode(oaLibMode libMode);

    void                    getLibAttributes(oaDMAttrArray &attrs) const;
    void                    addLibAttribute(const oaString  &attrName,
                                            const oaString  &attrVal);
    void                    removeLibAttribute(const oaString &attrName);

};



// *****************************************************************************
// oaLibDefListRef
// *****************************************************************************
class OA_DM_DLL_API oaLibDefListRef : public oaLibDefListMem {
public:
    static oaLibDefListRef  *create(oaLibDefList    *libList,
                                    const oaString  &refListPath,
                                    oaLibDefListMem *followingMem = NULL);

    static oaLibDefListRef  *find(const oaLibDefList    *defList,
                                  const oaString        &refListPath);

    void                    getRefListPath(oaString &path) const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaLibDefListMem> {
public:
    typedef oaSessionObject             parentType;
    typedef oaLibDefListMemModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {abstractTypeEnumVal = oacLibDefListMemType};
};

template<>
class oaTraits<oaLibDef> {
public:
    typedef oaLibDefListMem parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacLibDefType};
};

template<>
class oaTraits<oaLibDefListRef> {
public:
    typedef oaLibDefListMem parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacLibDefListRefType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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