00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::Dictionary 00026 00027 Description 00028 Gerneral purpose template dictionary class which manages the storage 00029 associated with it. 00030 00031 It is derived from DictionaryBase instantiated on a memory managed form 00032 of intrusive doubly-linked list of <T>. 00033 00034 SourceFiles 00035 Dictionary_.C 00036 00037 \*---------------------------------------------------------------------------*/ 00038 00039 #ifndef Dictionary_H 00040 #define Dictionary_H 00041 00042 #include <OpenFOAM/DictionaryBase.H> 00043 #include <OpenFOAM/IDLList.H> 00044 00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00046 00047 namespace Foam 00048 { 00049 00050 /*---------------------------------------------------------------------------*\ 00051 Class Dictionary Declaration 00052 \*---------------------------------------------------------------------------*/ 00053 00054 template<class T> 00055 class Dictionary 00056 : 00057 public DictionaryBase<IDLList<T>, T> 00058 { 00059 00060 public: 00061 00062 // Constructors 00063 00064 //- Null constructor 00065 Dictionary(); 00066 00067 //- Copy construct 00068 Dictionary(const Dictionary&); 00069 00070 00071 // Member functions 00072 00073 //- Remove an entry specified by keyword and delete the pointer. 00074 // Returns true if the keyword was found 00075 bool erase(const word& keyword); 00076 }; 00077 00078 00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00080 00081 } // End namespace Foam 00082 00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00084 00085 #ifdef NoRepository 00086 # include "Dictionary_.C" 00087 #endif 00088 00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00090 00091 #endif 00092 00093 // ************************ vim: set sw=4 sts=4 et: ************************ //
