src/foam/graph/curve/curve.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::curve
  26
  27 Description
  28     A single curve in a graph.
  29
  30 SourceFiles
  31     curve.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef curve_H
  36 #define curve_H
  37
  38 #include "foamString.H"
  39 #include "primitiveFields.H"
  40 #include "autoPtr.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 class curve;
  50 Ostream& operator<<(Ostream&, const curve&);
  51
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class curve Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class curve
  58 :
  59     public scalarField
  60 {
  61
  62 public:
  63
  64     //- The style (line, symbol, etc) of a curve
  65     class curveStyle
  66     {
  67
  68     public:
  69
  70         //- Enumeration definitions
  71         enum curveStyleNo
  72         {
  73             CONTINUOUS,
  74             SYMBOL,
  75             SYMBOL_CURVE,
  76             SYMBOL_WITH_ERROR_BARS,
  77             SYMBOL_WITH_VARIABLE_SIZE
  78         };
  79
  80
  81     private:
  82
  83         //- Private data
  84         curveStyleNo CurveStyleNo;
  85
  86
  87     public:
  88
  89
  90         // Constructors
  91
  92             //- Construct given a curveStyleNo
  93             curveStyle(const curveStyleNo csn)
  94             :
  95                 CurveStyleNo(csn)
  96             {}
  97
  98             //- Construct from Istream
  99             curveStyle(Istream& is)
 100             :
 101                 CurveStyleNo(curveStyleNo(readInt(is)))
 102             {}
 103
 104
 105         // Ostream operator
 106
 107             friend Ostream& operator<<(Ostream& os, const curveStyle& cs)
 108             {
 109                 os << int(cs.CurveStyleNo);
 110                 return os;
 111             }
 112     };
 113
 114
 115 private:
 116
 117     // private data
 118
 119         string name_;
 120         curveStyle style_;
 121
 122
 123 public:
 124
 125     // Constructors
 126
 127         //- Construct as interpolation of an existing curve
 128         //curve(const curve&, const label);
 129
 130         //- Construct from name, style and size
 131         curve
 132         (
 133             const string& name,
 134             const curveStyle& style,
 135             const label l
 136         );
 137
 138         //- Construct from the components
 139         curve
 140         (
 141             const string&,
 142             const curveStyle&,
 143             const scalarField& y
 144         );
 145
 146         //- Create and return a clone
 147         autoPtr<curve> clone() const
 148         {
 149             return autoPtr<curve>(new curve(*this));
 150         }
 151
 152
 153     // Member functions
 154
 155         // Access
 156
 157             const string& name() const
 158             {
 159                 return name_;
 160             }
 161
 162             const curveStyle& style() const
 163             {
 164                 return style_;
 165             }
 166
 167
 168     // Friend functions
 169
 170         //- Gradient of the curve
 171         //friend curve grad(const curve&);
 172
 173
 174     // Ostream operator
 175
 176         friend Ostream& operator<<(Ostream&, const curve&);
 177 };
 178
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 } // End namespace Foam
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 #endif
 187
 188 // ************************************************************************* //