src/foam/db/scalarRange/scalarRange.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::scalarRange
  26
  27 Description
  28     A scalar range specifier.
  29
  30     The range selector can be specified as an "LOWER:UPPER" range, as a
  31     "LOWER:" bound, as an ":UPPER" bound or simply as an "EXACT" value.
  32     The read constructor uses a colon (:) as a range marker and a comma (,)
  33     to delimit the next possible range selector.
  34
  35 SourceFiles
  36     scalarRange.C
  37
  38 \*---------------------------------------------------------------------------*/
  39 #ifndef scalarRange_H
  40 #define scalarRange_H
  41
  42 #include "scalar.H"
  43 #include "debugSwitch.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of classes
  51 class Istream;
  52 class Ostream;
  53
  54 // Forward declaration of friend functions and operators
  55 class scalarRange;
  56 Istream& operator>>(Istream&, scalarRange&);
  57 Ostream& operator<<(Ostream&, const scalarRange&);
  58
  59
  60 /*---------------------------------------------------------------------------*\
  61                         Class scalarRange Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class scalarRange
  65 {
  66     //- Enumeration defining the types of token
  67     enum rangeType
  68     {
  69         EMPTY = 0,
  70         EXACT,
  71         LOWER,
  72         UPPER,
  73         RANGE
  74     };
  75
  76
  77     // Private data
  78
  79         enum rangeType type_;
  80         scalar value_;
  81         scalar value2_;
  82
  83
  84 public:
  85
  86         static debug::debugSwitch debug;
  87
  88
  89     // Constructors
  90
  91         //- Construct Null
  92         scalarRange();
  93
  94         //- Construct a Range
  95         scalarRange(const scalar& lower, const scalar& upper);
  96
  97         //- Construct from Istream.
  98         //  Since commas can be used as list delimiters,
  99         //  leading and trailing commas are ignored.
 100         scalarRange(Istream&);
 101
 102
 103     // Member Functions
 104
 105         //- Is the range non-empty?
 106         bool isDefined() const;
 107
 108         //- Is the range 'EXACT'?
 109         bool isExact() const;
 110
 111         //- The value constituting an 'EXACT' match
 112         //  or the values for 'UPPER' or 'LOWER' limits
 113         scalar value() const;
 114
 115         //- The lower limit
 116         scalar lower() const;
 117
 118         //- The upper limit
 119         scalar upper() const;
 120
 121         //- Return true if the value is within the range
 122         bool selected(const scalar&) const;
 123
 124
 125     // Member Operators
 126
 127         bool operator==(const scalarRange&) const;
 128         bool operator!=(const scalarRange&) const;
 129
 130
 131     // IOstream Operators
 132
 133         friend Istream& operator>>(Istream&, scalarRange&);
 134         friend Ostream& operator<<(Ostream&, const scalarRange&);
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 #endif
 145
 146 // ************************************************************************* //