src/OpenFOAM/containers/Dictionaries/PtrDictionary/PtrDictionary.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::PtrDictionary
  27
  28 Description
  29     Template dictionary class which does not manages the storage
  30     associated with it.
  31
  32     It is derived from DictionaryBase instantiated on a non-memory managed
  33     form of intrusive doubly-linked list of T.
  34
  35 SourceFiles
  36     PtrDictionary.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef PtrDictionary_H
  41 #define PtrDictionary_H
  42
  43 #include "DictionaryBase.H"
  44 #include "DLPtrList.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                         Class PtrDictionary Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class T>
  56 class PtrDictionary
  57 :
  58     public DictionaryBase<DLPtrList<T>, T>
  59 {
  60
  61 public:
  62
  63     // Constructors
  64
  65         //- Null constructor
  66         PtrDictionary();
  67
  68         //- Copy construct
  69         PtrDictionary(const PtrDictionary&);
  70
  71         //- Construct from Istream using given Istream constructor class
  72         template<class INew>
  73         PtrDictionary(Istream&, const INew&);
  74
  75         //- Construct from Istream
  76         PtrDictionary(Istream&);
  77 };
  78
  79
  80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  81
  82 } // End namespace Foam
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 #ifdef NoRepository
  87 #   include "PtrDictionary.C"
  88 #endif
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 #endif
  93
  94 // ************************************************************************* //