/usr/include/dolfin/io/File.h is in libdolfin1.0-dev 1.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | // Copyright (C) 2002-2011 Johan Hoffman, Anders Logg and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Magnus Vikstrom 2007
// Modified by Nuno Lopes 2008
// Modified by Ola Skavhaug 2009
//
// First added: 2002-11-12
// Last changed: 2011-09-27
#ifndef __FILE_H
#define __FILE_H
#include <ostream>
#include <string>
#include <utility>
#include <boost/scoped_ptr.hpp>
#include "GenericFile.h"
namespace dolfin
{
/// A File represents a data file for reading and writing objects.
/// Unless specified explicitly, the format is determined by the
/// file name suffix.
/// A list of objects that can be read/written to file can be found in
/// GenericFile.h. Compatible file formats include:
/// * XML (.xml)
/// * VTK (.pvd)
/// * RAW (.raw)
/// * XYZ (.xyz)
/// * Binary (.bin)
class File
{
public:
/// File formats
enum Type {xml, vtk, raw, xyz, binary};
/// Create a file with given name
///
/// *Arguments*
/// filename (std::string)
/// Name of file.
/// encoding (std::string)
/// Optional argument specifying encoding, ascii is default.
///
/// *Example*
/// .. code-block:: c++
///
/// // Save solution to file
/// File file("solution.pvd");
/// file << u;
///
/// // Read mesh data from file
/// File mesh_file("mesh.xml");
/// mesh_file >> mesh;
///
/// // Using compressed binary format
/// File comp_file("solution.pvd", "compressed");
///
File(const std::string filename, std::string encoding="ascii");
/// Create a file with given name and type (format)
///
/// *Arguments*
/// filename (std::string)
/// Name of file.
/// type (Type)
/// File format.
/// encoding (std::string)
/// Optional argument specifying encoding, ascii is default.
///
/// *Example*
/// .. code-block:: c++
///
/// File file("solution", vtk);
///
File(const std::string filename, Type type, std::string encoding="ascii");
/// Create an outfile object writing to stream
///
/// *Arguments*
/// outstream (std::ostream)
/// The stream.
File(std::ostream& outstream);
/// Destructor
~File();
/// Read from file
template<typename T> void operator>>(T& t)
{
file->read();
*file >> t;
}
/// Write Function to file
//void operator<<(const Function& u);
/// Write Function to file with time
///
/// *Example*
/// .. code-block:: c++
///
/// File file("solution.pvd", "compressed");
/// file << std::make_pair<const Function*, double>(&u, t);
///
void operator<<(const std::pair<const Function*, double> u);
/// Write object to file
template<typename T> void operator<<(const T& t)
{
file->write();
*file << t;
}
/// Check if file exists
///
/// *Arguments*
/// filename (std::string)
/// Name of file.
///
/// *Returns*
/// bool
/// True if the file exists.
static bool exists(std::string filename);
// Create parent path for file if file has a parent path
///
/// *Arguments*
/// filename (std::string)
/// Name of file / path.
static void create_parent_path(std::string filename);
private:
// Pointer to implementation (envelope-letter design)
boost::scoped_ptr<GenericFile> file;
};
}
#endif
|