src/OpenFOAM/primitives/nil/nil.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::nil
  27
  28 Description
  29     A zero-sized class without any storage. Used, for example, in HashSet.
  30
  31 Note
  32     A zero-sized class actually does still require at least 1 byte storage.
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef nil_H
  37 #define nil_H
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 // Forward declaration of classes
  45 class Istream;
  46 class Ostream;
  47
  48 // Forward declaration of friend functions and operators
  49
  50 class nil;
  51
  52 Istream& operator>>(Istream&, nil&);
  53 Ostream& operator<<(Ostream&, const nil&);
  54
  55
  56 /*---------------------------------------------------------------------------*\
  57                              Class nil Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class nil
  61 {
  62
  63 public:
  64
  65     // Constructors
  66
  67         //- Construct null
  68         nil()
  69         {}
  70
  71         //- Construct from Istream
  72         nil(Istream&)
  73         {}
  74
  75
  76     // IOstream Operators
  77
  78         friend Istream& operator>>(Istream& is, nil&)
  79         {
  80             return is;
  81         }
  82
  83         friend Ostream& operator<<(Ostream& os, const nil&)
  84         {
  85             return os;
  86         }
  87 };
  88
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 } // End namespace Foam
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 #endif
  97
  98 // ************************************************************************* //