/usr/include/casacore/casa/IO/RegularFileIO.h is in casacore-dev 2.2.0-2.
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 | //# RegularFileIO.h: Class for IO on a regular file
//# Copyright (C) 1996,1997,1999,2001,2002
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef CASA_REGULARFILEIO_H
#define CASA_REGULARFILEIO_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/IO/FilebufIO.h>
#include <casacore/casa/OS/RegularFile.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Class for IO on a regular file.
// </summary>
// <use visibility=export>
// <reviewed reviewer="Friso Olnon" date="1996/11/06" tests="tByteIO" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=FilebufIO>FilebufIO</linkto> class
// </prerequisite>
// <synopsis>
// This class is a specialization of class
// <linkto class=ByteIO>ByteIO</linkto>. It uses a
// <linkto class=RegularFile>regular file</linkto> as the data store.
// <p>
// The class is derived from <linkto class=FilebufIO>FilebufIO</linkto>,
// which contains all functions to access the file. The description of
// this class explains the use of the <src>filebufSize</src> argument
// in the constructor.
// </synopsis>
// <example>
// <srcblock>
// // Create a file (which should not exist yet).
// RegularFileIO regio (RegularFile("file.name"), ByteIO::NewNoReplace);
// // Use that as the sink of AipsIO.
// AipsIO stream (®io);
// // Write values.
// stream << (Int)10;
// stream << True;
// // Seek to beginning of file and read data in.
// stream.setpos (0);
// Int vali;
// Bool valb;
// stream >> vali >> valb;
// </srcblock>
// </example>
class RegularFileIO: public FilebufIO
{
public:
// Create an IO stream object for a regular file with the given name.
// The ByteIO option determines if the file will be created
// or opened for input and/or output.
// <br>
// The argument <src>filebufSize</src> defines the length of
// the internal buffer in the underlying <linkto class=FilebufIO>
// FilebufIO</linkto> object. A zero length uses an appropriate default.
explicit RegularFileIO (const RegularFile& regularFile,
ByteIO::OpenOption = ByteIO::Old,
uInt filebufSize=0);
~RegularFileIO();
// Reopen the underlying file for read/write access.
// Nothing will be done if the stream is writable already.
// Otherwise it will be reopened and an exception will be thrown
// if it is not possible to reopen it for read/write access.
virtual void reopenRW();
// Get the file name of the file attached.
virtual String fileName() const;
// Convenience function to open or create a file.
// Optionally it is checked if the file does not exist yet.
// It returns the file descriptor.
static int openCreate (const RegularFile& file, ByteIO::OpenOption);
private:
OpenOption itsOption;
RegularFile itsRegularFile;
// Copy constructor, should not be used.
RegularFileIO (const RegularFileIO& that);
// Assignment, should not be used.
RegularFileIO& operator= (const RegularFileIO& that);
};
} //# NAMESPACE CASACORE - END
#endif
|