src/OSspecific/Unix/fileStat.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::fileStat
  27
  28 Description
  29     Wrapper for stat() system call.
  30
  31 Warning
  32     on Linux (an maybe on others) a stat() of an nfs mounted (remote)
  33     file does never timeout and cannot be interrupted!
  34     So e.g. Foam::ping first and hope nfs is running.
  35
  36 SourceFiles
  37     fileStat.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef fileStat_H
  42 #define fileStat_H
  43
  44 #include <sys/stat.h>
  45 #include <sys/types.h>
  46
  47 #include "label.H"
  48 #include "fileName.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 // Forward declaration of friend functions and operators
  56
  57 class fileStat;
  58
  59 Istream& operator>>(Istream&, fileStat&);
  60 Ostream& operator<<(Ostream&, const fileStat&);
  61
  62
  63 /*---------------------------------------------------------------------------*\
  64                            Class fileStat Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class fileStat
  68 {
  69     // Private data
  70
  71         struct stat status_;
  72
  73         bool isValid_;
  74
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Empty constructor
  81         fileStat();
  82
  83         //- Construct from components
  84         fileStat(const fileName& fName, const unsigned int maxTime=0);
  85
  86         //- Construct from Istream
  87         fileStat(Istream&);
  88
  89
  90     // Member Functions
  91
  92         // Access
  93
  94             //- Raw status
  95             const struct stat& status() const
  96             {
  97                 return status_;
  98             }
  99
 100             //- Did constructor fail
 101             bool isValid() const
 102             {
 103                 return isValid_;
 104             }
 105
 106
 107         // Check
 108
 109             //- compare two fileStats for same device
 110             bool sameDevice(const fileStat& stat2) const;
 111
 112             //- compare two fileStats for same Inode
 113             bool sameINode(const fileStat& stat2) const;
 114
 115             //- compare state against inode
 116             bool sameINode(const label iNode) const;
 117
 118
 119     // IOstream Operators
 120
 121         friend Istream& operator>>(Istream&, fileStat&);
 122         friend Ostream& operator<<(Ostream&, const fileStat&);
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //