src/foam/db/postfixedSubRegistry/postfixedSubRegistry.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::postfixedSubRegistry
  26
  27 Description
  28     Registry of regIOobjects
  29
  30 SourceFiles
  31     postfixedSubRegistry.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef postfixedSubRegistry_H
  36 #define postfixedSubRegistry_H
  37
  38 #include "objectRegistry.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                       Class postfixedSubRegistry Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class postfixedSubRegistry
  50 :
  51     public objectRegistry
  52 {
  53     // Private Member Functions
  54
  55         //- Disallow Copy constructor
  56         postfixedSubRegistry(const postfixedSubRegistry&);
  57
  58         //- Disallow default bitwise copy construct and assignment
  59         void operator=(const postfixedSubRegistry&);
  60
  61
  62 public:
  63
  64     //- Declare type name for this IOobject
  65     TypeName("postfixedSubRegistry");
  66
  67
  68     // Constructors
  69
  70         //- Construct a sub-registry given an IObject to describe the registry
  71         //  and an initial estimate for the number of entries
  72         explicit postfixedSubRegistry
  73         (
  74             const IOobject& io,
  75             const label nIoObjects = 128
  76         );
  77
  78
  79     // Destructor
  80
  81         virtual ~postfixedSubRegistry();
  82
  83
  84     // Member functions
  85
  86         // Access
  87
  88             //- Return mangled fileName
  89             virtual fileName mangleFileName (const fileName&) const;
  90
  91         // Edit
  92
  93             //- Add an regIOobject to registry
  94             virtual bool checkIn(regIOobject&) const;
  95
  96             //- Remove an regIOobject from registry
  97             virtual bool checkOut(regIOobject&) const;
  98
  99         // Reading
 100
 101             //- Return true if any of the object's files have been modified
 102             virtual bool modified() const
 103             {
 104                 return false;
 105             }
 106
 107             //- Read object if modified
 108             virtual bool readIfModified()
 109             {
 110                 return true;
 111             }
 112
 113         // Writing
 114
 115             virtual bool writeObject
 116             (
 117                 IOstream::streamFormat fmt,
 118                 IOstream::versionNumber ver,
 119                 IOstream::compressionType cmp
 120             ) const
 121             {
 122                 return true;
 123             }
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace Foam
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //