Chemical Data Processing Library C++ API - Version 1.1.1
CDFDRegularGridWriter.hpp
Go to the documentation of this file.
1 /*
2  * CDFDRegularGridWriter.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_GRID_CDFDREGULARGRIDWRITER_HPP
30 #define CDPL_GRID_CDFDREGULARGRIDWRITER_HPP
31 
32 #include <memory>
33 #include <iosfwd>
34 
35 #include "CDPL/Grid/APIPrefix.hpp"
37 #include "CDPL/Base/DataWriter.hpp"
38 
39 
40 namespace CDPL
41 {
42 
43  namespace Grid
44  {
45 
46  class CDFRegularGridDataWriter;
47 
52  {
53 
54  public:
60  CDFDRegularGridWriter(std::ostream& os);
61 
66 
73 
74  operator const void*() const;
75  bool operator!() const;
76 
77  private:
78  typedef std::unique_ptr<CDFRegularGridDataWriter> CDFDataWriterPtr;
79 
81 
83 
84  std::ostream& output;
85  bool state;
86  CDFDataWriterPtr writer;
87  };
88  } // namespace Grid
89 } // namespace CDPL
90 
91 #endif // CDPL_GRID_CDFDREGULARGRIDWRITER_HPP
DataWriter.hpp
Definition of the class CDPL::Base::DataWriter.
CDPL::Grid::CDFDRegularGridWriter::operator!
bool operator!() const
CDPL::Grid::CDFDRegularGridWriter::CDFDRegularGridWriter
CDFDRegularGridWriter(std::ostream &os)
Constructs a CDFDRegularGridWriter instance that will write data of spatial regular grids to the outp...
CDPL::Grid::CDFDRegularGridWriter::write
Base::DataWriter< DRegularGrid > & write(const DRegularGrid &grid)
Writes data of the spatial regular grid grid to the output stream specified in the constructor.
CDPL::Grid::CDFDRegularGridWriter::~CDFDRegularGridWriter
~CDFDRegularGridWriter()
Destructor.
APIPrefix.hpp
Definition of the preprocessor macro CDPL_GRID_API.
RegularGrid.hpp
Definition of a regular spatial grid data type.
CDPL_GRID_API
#define CDPL_GRID_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Grid::RegularGrid
RegularGrid.
Definition: RegularGrid.hpp:48
CDPL::Grid::CDFDRegularGridWriter
A writer for spatial regular grid data in the native I/O format of the CDPL.
Definition: CDFDRegularGridWriter.hpp:52
CDPL::Base::DataWriter
An interface for writing data objects of a given type to an arbitrary data sink.
Definition: DataWriter.hpp:63