oaLibDefList.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaLibDefList.h
//
// This file contains the declaration of the oaLibDefList class. This class
// implements an ordered list of library definitions. Library definition lists
// can be nested by having a reference to another list as a member. An
// oaLibDefList object allows the user to query and manage the contents of
// their library definition files.
//
// *****************************************************************************
// 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$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaLibDefList_P)
#define oaLibDefList_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaSessionObject.h"
#include "oaCollection.h"
#include "oaDMTypes.h"
#include "oaBaseModTypes.h"



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



// *****************************************************************************
// oaLibDefListWarningEnum
// *****************************************************************************
enum oaLibDefListWarningTypeEnum {
    oacNoDefaultLibDefListWarning           = 0,
    oacCannotOpenDefaultLibDefListWarning   = 1,
    oacSyntaxErrorLibDefListWarning         = 2,
    oacCannotOpenIncludeLibDefListWarning   = 3,
    oacRecursiveIncludeLibDefListWarning    = 4,
    oacMultiDefinitionsLibDefListWarning    = 5,
    oacCannotOpenLibLibDefListWarning       = 6,
    oacUndefinedVarLibDefListWarning        = 7,
    oacLibNameUndefinedLibDefListWarning    = 8
};



// *****************************************************************************
// oaLibDefList
// *****************************************************************************
class OA_DM_DLL_API oaLibDefList : public oaSessionObject {
public:
    static void                                     openLibs();
    static void                                     openLibs(const oaString &path);

    static oaLibDefList                             *getTopList();
    static void                                     getDefaultPath(oaString &path);
    static void                                     getDefaultFileName(oaString &libDefName);

    static oaLibDefList                             *create(const oaString &filePath);

    static oaLibDefList                             *get(const oaString &filePath,
                                                         oaChar         mode);

    static oaLibDefList                             *find(const oaString &filePath);

    void                                            open();

    void                                            save();
    void                                            saveAs(const oaString &path);

    void                                            getPath(oaString &path) const;
    void                                            getFullPath(oaString &path) const;
    oaChar                                          getMode() const;

    void                                            destroy();

    oaCollection<oaLibDefListMem, oaLibDefList>     getMembers() const;
    static oaCollection<oaLibDefList, oaLibDefList> getLibDefLists();
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaLibDefList> {
public:
    typedef oaSessionObject         parentType;
    typedef oaLibDefListModTypeEnum modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacLibDefListType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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