/usr/include/casacore/casa/IO/ByteSource.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 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 | //# ByteSource.h: Class for read-only access to data in a given format
//# Copyright (C) 1996,1999,2001
//# 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_BYTESOURCE_H
#define CASA_BYTESOURCE_H
#include <casacore/casa/aips.h>
#include <casacore/casa/IO/BaseSinkSource.h>
//# The following should be a forward declaration. But our Complex & DComplex
//# classes are a typedef hence this does not work. Replace the following with
//# forward declarations when Complex and DComplex are no longer typedefs.
#include <casacore/casa/BasicSL/Complex.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class TypeIO;
class String;
// <summary>Class for read-only access to data in a given format.</summary>
// <use visibility=export>
// <reviewed reviewer="Friso Olnon" date="1996/11/06" tests="tByteSink" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=BaseSinkSource>BaseSinkSource</linkto> class
// <li> <linkto class=TypeIO>TypeIO</linkto> class and derived classes
// </prerequisite>
// <etymology>
// A source is the place where bytes are read from.
// </etymology>
// <synopsis>
// ByteSource provides read-only access to a typed byte stream in the
// Casacore IO framework. The base class <src>BaseSinkSource</src>
// contains common functions like <src>seek</src>.
// <p>
// The object is constructed using a typed byte stream. This stream
// is an instance of a class derived from class
// <linkto class=TypeIO>TypeIO</linkto>. This makes it possible to
// read the data in any format (e.g. CanonicalIO or RawIO).
// <br> In its turn TypeIO uses an instance of a class derived from class
// <linkto class=ByteIO>ByteIO</linkto>. This makes it possible to
// use any input stream (e.g. file, memory).
// </synopsis>
// <example>
// <srcblock>
// // Construct the correct input stream.
// RegularFileIO filio ("file.name");
// CanonicalIO canio (&filio);
// ByteSource source (&canio);
// // Read data.
// Int vali;
// Bool flag;
// source >> vali >> flag;
// </srcblock>
// </example>
// <motivation>
// This class makes it possible to deny write-access to an IO stream.
// </motivation>
class ByteSource: virtual public BaseSinkSource
{
public:
// Default constructor.
// This creates an invalid object, but is present for convenience.
ByteSource();
// Construct from given TypeIO object. The constructor does not copy the
// object, but only keeps a pointer to it. If takeOver is true the this
// class will delete the supplied pointer. Otherwise the caller is
// responsible for this.
ByteSource (TypeIO* typeIO, Bool takeOver=False);
// The copy constructor uses reference semantics
ByteSource (const ByteSource& source);
// The assignment operator uses reference semantics
ByteSource& operator= (const ByteSource& source);
// destructor
~ByteSource();
// These functions read one value of the given type.
// If this function does not succeed, an exception will be thrown.
// <group>
ByteSource& operator>> (Bool& value);
ByteSource& operator>> (Char& value);
ByteSource& operator>> (uChar& value);
ByteSource& operator>> (Short& value);
ByteSource& operator>> (uShort& value);
ByteSource& operator>> (Int& value);
ByteSource& operator>> (uInt& value);
ByteSource& operator>> (Int64& value);
ByteSource& operator>> (uInt64& value);
ByteSource& operator>> (Float& value);
ByteSource& operator>> (Double& value);
ByteSource& operator>> (Complex& value);
ByteSource& operator>> (DComplex& value);
ByteSource& operator>> (String& value);
// </group>
// These functions read multiple values of the given type.
// If this function does not succeed, an exception will be thrown.
// <group>
void read (size_t nvalues, Bool* value);
void read (size_t nvalues, Char* value);
void read (size_t nvalues, uChar* value);
void read (size_t nvalues, Short* value);
void read (size_t nvalues, uShort* value);
void read (size_t nvalues, Int* value);
void read (size_t nvalues, uInt* value);
void read (size_t nvalues, Int64* value);
void read (size_t nvalues, uInt64* value);
void read (size_t nvalues, Float* value);
void read (size_t nvalues, Double* value);
void read (size_t nvalues, Complex* value);
void read (size_t nvalues, DComplex* value);
void read (size_t nvalues, String* value);
// </group>
protected:
};
} //# NAMESPACE CASACORE - END
#endif
|