src/OSspecific/POSIX/fileStat.H

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