src/OpenFOAM/db/objectRegistry/objectRegistry.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::objectRegistry
  27
  28 Description
  29     Registry of regIOobjects
  30
  31 SourceFiles
  32     objectRegistry.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef objectRegistry_H
  37 #define objectRegistry_H
  38
  39 #include "HashTable.H"
  40 #include "regIOobject.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class objectRegistry Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class objectRegistry
  52 :
  53     public regIOobject,
  54 #ifndef SWIG
  55     public HashTable<regIOobject*>
  56 #else
  57     public HashTable<regIOobject*, word, string_hash>
  58 #endif
  59 {
  60     // Private Data
  61
  62         //- Master time objectRegistry
  63         const Time& time_;
  64
  65         //- Parent objectRegistry
  66         const objectRegistry& parent_;
  67
  68         //- Local directory path of this objectRegistry relative to time
  69         fileName dbDir_;
  70
  71         //- Current event
  72         mutable label event_;
  73
  74
  75     // Private Member Functions
  76
  77         //- Disallow Copy constructor
  78         objectRegistry(const objectRegistry&);
  79
  80         //- Disallow default bitwise copy construct and assignment
  81         void operator=(const objectRegistry&);
  82
  83
  84 public:
  85
  86     //- Declare type name for this IOobject
  87     TypeName("objectRegistry");
  88
  89
  90     // Constructors
  91
  92         //- Construct the time objectRegistry given an initial estimate
  93         //  for the number of entries
  94         explicit objectRegistry
  95         (
  96             const Time& db,
  97             const label nIoObjects = 128
  98         );
  99
 100         //- Construct a sub-registry given an IObject to describe the registry
 101         //  and an initial estimate for the number of entries
 102         explicit objectRegistry
 103         (
 104             const IOobject& io,
 105             const label nIoObjects = 128
 106         );
 107
 108
 109     // Destructor
 110
 111         virtual ~objectRegistry();
 112
 113
 114     // Member functions
 115
 116         // Access
 117
 118             //- Return time
 119             const Time& time() const
 120             {
 121                 return time_;
 122             }
 123
 124             //- Return the parent objectRegistry
 125             const objectRegistry& parent() const
 126             {
 127                 return parent_;
 128             }
 129
 130             //- Local directory path of this objectRegistry relative to the time
 131             virtual const fileName& dbDir() const
 132             {
 133                 return dbDir_;
 134             }
 135
 136             //- Return the list of names of the IOobjects
 137             wordList names() const;
 138
 139             //- Return the list of names of the IOobjects of given class name
 140             wordList names(const word& className) const;
 141
 142             //- Return the list of names of the IOobjects of given type
 143             template<class Type>
 144             wordList names() const;
 145
 146             //- Lookup and return a const sub-objectRegistry
 147             const objectRegistry& subRegistry(const word& name) const;
 148
 149             //- Lookup and return all the object of the given Type
 150             template<class Type>
 151             HashTable<const Type*> lookupClass() const;
 152
 153             //- Is the named Type
 154             template<class Type>
 155             bool foundObject(const word& name) const;
 156
 157             //- Lookup and return the object of the given Type
 158             template<class Type>
 159             const Type& lookupObject(const word& name) const;
 160
 161             //- Return new event number.
 162             label getEvent() const;
 163
 164
 165         // Edit
 166
 167             //- Rename
 168             virtual void rename(const word& newName);
 169
 170             //- Add an regIOobject to registry
 171             bool checkIn(regIOobject&) const;
 172
 173             //- Remove an regIOobject from registry
 174             bool checkOut(regIOobject&) const;
 175
 176
 177         // Reading
 178
 179             //- Return true if any of the object's files have been modified
 180             virtual bool modified() const;
 181
 182             //- Read the objects that have been modified
 183             void readModifiedObjects();
 184
 185             //- Read object if modified
 186             virtual bool readIfModified();
 187
 188
 189         // Writing
 190
 191             //- writeData function required by regIOobject but not used
 192             //  for this class, write is used instead
 193             virtual bool writeData(Ostream&) const
 194             {
 195                 notImplemented
 196                 (
 197                     "void objectRegistry::writeData(Ostream&) const: "
 198                     "use write() instead"
 199                 );
 200
 201                 return false;
 202             }
 203
 204             //- Write the objects
 205             virtual bool writeObject
 206             (
 207                 IOstream::streamFormat fmt,
 208                 IOstream::versionNumber ver,
 209                 IOstream::compressionType cmp
 210             ) const;
 211 };
 212
 213
 214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 215
 216 } // End namespace Foam
 217
 218 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 219
 220 #ifdef NoRepository
 221 #   include "objectRegistryTemplates.C"
 222 #endif
 223
 224 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 225
 226 #endif
 227
 228 // ************************************************************************* //