src/foam/db/regIOobject/regIOobjectWrite.C

   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 Description
  25     write function for regIOobjects
  26
  27 \*---------------------------------------------------------------------------*/
  28
  29 #include "regIOobject.H"
  30 #include "objectRegistry.H"
  31 #include "OSspecific.H"
  32 #include "OFstream.H"
  33
  34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  35
  36 bool Foam::regIOobject::writeObject
  37 (
  38     IOstream::streamFormat fmt,
  39     IOstream::versionNumber ver,
  40     IOstream::compressionType cmp
  41 ) const
  42 {
  43     if (!good())
  44     {
  45         SeriousErrorIn("regIOobject::write()")
  46             << "bad object " << name()
  47             << endl;
  48
  49         return false;
  50     }
  51
  52     if (instance().empty())
  53     {
  54         SeriousErrorIn("regIOobject::write()")
  55             << "instance undefined for object " << name()
  56             << endl;
  57
  58         return false;
  59     }
  60
  61     if
  62     (
  63         instance() != time().timeName()
  64      && instance() != time().system()
  65      && instance() != time().caseSystem()
  66      && instance() != time().constant()
  67      && instance() != time().caseConstant()
  68     )
  69     {
  70         const_cast<regIOobject&>(*this).instance() = time().timeName();
  71     }
  72
  73     mkDir(path());
  74
  75     if (OFstream::debug)
  76     {
  77         Info<< "regIOobject::write() : "
  78             << "writing file " << objectPath();
  79     }
  80
  81
  82     bool osGood = false;
  83
  84     {
  85         // Try opening an OFstream for object
  86         // Stream open for over-write.  HJ, 17/Aug/2010
  87         OFstream os
  88         (
  89             objectPath(),
  90             ios_base::out|ios_base::trunc,
  91             fmt,
  92             ver,
  93             cmp
  94         );
  95
  96         // If any of these fail, return (leave error handling to Ostream class)
  97         if (!os.good())
  98         {
  99             return false;
 100         }
 101
 102         if (!writeHeader(os))
 103         {
 104             return false;
 105         }
 106
 107         // Write the data to the Ostream
 108         if (!writeData(os))
 109         {
 110             return false;
 111         }
 112
 113         writeEndDivider(os);
 114
 115         osGood = os.good();
 116     }
 117
 118     if (OFstream::debug)
 119     {
 120         Info<< " .... written" << endl;
 121     }
 122
 123     // Only update the lastModified_ time if this object is re-readable,
 124     // i.e. lastModified_ is already set
 125     if (lastModified_)
 126     {
 127         lastModified_ = lastModified(objectPath());
 128     }
 129
 130     return osGood;
 131 }
 132
 133
 134 bool Foam::regIOobject::write() const
 135 {
 136     return writeObject
 137     (
 138         time().writeFormat(),
 139         IOstream::currentVersion,
 140         time().writeCompression()
 141     );
 142 }
 143
 144 // ************************************************************************* //