src/OpenFOAM/graph/writers/gnuplotGraph/gnuplotGraph.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::gnuplotGraph
  26
  27 Description
  28     Output in gnuplot (http://www.gnuplot.info) format
  29
  30 SourceFiles
  31     gnuplotGraph.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef gnuplotGraph_H
  36 #define gnuplotGraph_H
  37
  38 #include "graph.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class gnuplotGraph Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class gnuplotGraph
  50 :
  51     public graph::writer
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("gnuplot");
  58
  59     //- FileName extension  for this graph format
  60     static const word ext_;
  61
  62
  63     // Constructors
  64
  65         //- Construct null
  66         gnuplotGraph()
  67         {}
  68
  69
  70     //- Destructor
  71     ~gnuplotGraph()
  72     {}
  73
  74
  75     // Member Functions
  76
  77         // Access
  78
  79             //- Return the appropriate fileName extension
  80             //  for this graph format
  81             const word& ext() const
  82             {
  83                 return ext_;
  84             }
  85
  86
  87         // Write
  88
  89             void write(const graph&, Ostream& os) const;
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #endif
 100
 101 // ************************************************************************* //