src/foam/db/objectRegistry/objectRegistry.H

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