src/sampling/sampledSet/writers/csv/csvSetWriter.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2011 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::csvSetWriter
  26
  27 Description
  28
  29 SourceFiles
  30     csvSetWriter.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef csvSetWriter_H
  35 #define csvSetWriter_H
  36
  37 #include "writer.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                        Class csvSetWriter Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 template<class Type>
  49 class csvSetWriter
  50 :
  51     public writer<Type>
  52 {
  53
  54     // Private Member Functions
  55
  56         void writeCoordHeader(const coordSet&, Ostream&) const;
  57
  58         void writeHeader(const coordSet&, const wordList&, Ostream&) const;
  59
  60 protected:
  61
  62     virtual void writeSeparator(Ostream&) const;
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("csv");
  68
  69
  70     // Constructors
  71
  72         //- Construct null
  73         csvSetWriter();
  74
  75
  76     //- Destructor
  77
  78         virtual ~csvSetWriter();
  79
  80
  81     // Member Functions
  82
  83         virtual fileName getFileName
  84         (
  85             const coordSet&,
  86             const wordList&
  87         ) const;
  88
  89         virtual void write
  90         (
  91             const coordSet&,
  92             const wordList&,
  93             const List<const Field<Type>*>&,
  94             Ostream&
  95         ) const;
  96
  97         virtual void write
  98         (
  99             const bool writeTracks,
 100             const PtrList<coordSet>&,
 101             const wordList& valueSetNames,
 102             const List<List<Field<Type> > >&,
 103             Ostream&
 104         ) const;
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #ifdef NoRepository
 115 #   include "csvSetWriter.C"
 116 #endif
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //