src/OpenFOAM/db/IOobjectList/IOobjectList.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::IOobjectList
  27
  28 Description
  29     List of IOobjects with searching and retrieving facilities.
  30
  31 SourceFiles
  32     IOobjectList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef IOobjectList_H
  37 #define IOobjectList_H
  38
  39 #include "HashPtrTable.H"
  40 #include "IOobject.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class IOobjectList Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class IOobjectList
  52 :
  53     public HashPtrTable<IOobject>
  54 {
  55     // Private Member Functions
  56
  57         //- Disallow default bitwise assignment
  58         void operator=(const IOobjectList&);
  59
  60
  61 public:
  62
  63     // Constructors
  64
  65         //- Construct given an initial estimate for the number of entries
  66         explicit IOobjectList(const label nIoObjects = 128);
  67
  68         //- Construct from objectRegistry and instance path
  69         IOobjectList
  70         (
  71             const objectRegistry& db,
  72             const fileName& instance,
  73             const fileName& local = ""
  74         );
  75
  76         //- Construct as copy
  77         IOobjectList(const IOobjectList&);
  78
  79
  80     // Destructor
  81
  82         ~IOobjectList();
  83
  84
  85     // Member functions
  86
  87         //- Add an IOobject to list
  88         bool add(IOobject&);
  89
  90         //- Remove an IOobject from list
  91         bool remove(IOobject&);
  92
  93         //- Lookup a given name and return IOobject ptr if found else NULL
  94         IOobject* lookup(const word& name) const;
  95
  96         //- Return the list for all IOobjects of given class
  97         IOobjectList lookupClass(const word& className) const;
  98
  99         //- Return the list of names of the IOobjects
 100         wordList names() const;
 101
 102         //- Return the list of names of the IOobjects of given class
 103         wordList names(const word& className) const;
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //