Loading...
Searching...
No Matches
CanonicalIO.h
Go to the documentation of this file.
//# CanonicalIO.h: Class for IO in canonical 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef CASA_CANONICALIO_H
#define CASA_CANONICALIO_H
#include <casacore/casa/aips.h>
#include <casacore/casa/IO/TypeIO.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 ByteIO;
class String;
// <summary>Class for IO in canonical format.</summary>
// <use visibility=export>
// <reviewed reviewer="Friso Olnon" date="1996/11/06" tests="tTypeIO" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=ByteIO>ByteIO</linkto> class and derived classes
// <li> <linkto class=TypeIO>TypeIO</linkto>class
// <li> <linkto class=CanonicalConversion>CanonicalConversion</linkto>
// </prerequisite>
// <synopsis>
// CanonicalIO is a specialization of class TypeIO to store
// data in canonical format.
// <p>
// The class converts the data to/from canonical data and reads/writes
// them from/into the ByteIO object given at construction time.
// Conversion is only done when really needed. If not needed, the
// data is directly read or written.
// <p>
// Canonical format is big-endian IEEE format, where longs are 8 bytes.
// Bools are stored as bits to be as space-efficient as possible.
// This means that on a 32-bit SUN or HP conversions only have to be done
// for Bools and longs. For a DEC-alpha, however, the data will always
// be converted because it is a little-endian machine.
// </synopsis>
class CanonicalIO: public TypeIO
{
public:
// Constructor.
// The read/write functions will use the given ByteIO object
// as the data store.
// <p>
// The read and write functions use an intermediate buffer to hold the data
// in canonical format. For small arrays it uses a fixed buffer with
// length <src>bufferLength</src>. For arrays not fitting in this buffer,
// it uses a temporary buffer allocated on the heap.
explicit CanonicalIO (const std::shared_ptr<ByteIO>& byteIO,
uInt bufferLength=4096);
// The copy constructor uses reference semantics
CanonicalIO (const CanonicalIO& canonicalIO);
// The assignment operator uses reference semantics
CanonicalIO& operator= (const CanonicalIO& canonicalIO);
// Destructor, deletes allocated memory.
~CanonicalIO();
// Convert the values and write them to the ByteIO object.
// Bool, complex and String values are handled by the base class.
// <group>
virtual size_t write (size_t nvalues, const Bool* value);
virtual size_t write (size_t nvalues, const Char* data);
virtual size_t write (size_t nvalues, const uChar* data);
virtual size_t write (size_t nvalues, const Short* data);
virtual size_t write (size_t nvalues, const uShort* data);
virtual size_t write (size_t nvalues, const Int* data);
virtual size_t write (size_t nvalues, const uInt* data);
virtual size_t write (size_t nvalues, const Int64* data);
virtual size_t write (size_t nvalues, const uInt64* data);
virtual size_t write (size_t nvalues, const Float* data);
virtual size_t write (size_t nvalues, const Double* data);
virtual size_t write (size_t nvalues, const Complex* value);
virtual size_t write (size_t nvalues, const DComplex* value);
virtual size_t write (size_t nvalues, const String* value);
// </group>
// Read the values from the ByteIO object and convert them.
// Bool, complex and String values are handled by the base class.
// <group>
virtual size_t read (size_t nvalues, Bool* value);
virtual size_t read (size_t nvalues, Char* data);
virtual size_t read (size_t nvalues, uChar* data);
virtual size_t read (size_t nvalues, Short* data);
virtual size_t read (size_t nvalues, uShort* data);
virtual size_t read (size_t nvalues, Int* data);
virtual size_t read (size_t nvalues, uInt* data);
virtual size_t read (size_t nvalues, Int64* data);
virtual size_t read (size_t nvalues, uInt64* data);
virtual size_t read (size_t nvalues, Float* data);
virtual size_t read (size_t nvalues, Double* data);
virtual size_t read (size_t nvalues, Complex* value);
virtual size_t read (size_t nvalues, DComplex* value);
virtual size_t read (size_t nvalues, String* value);
// </group>
private:
//# The buffer
char* itsBuffer;
uInt itsBufferLength;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ByteIO
Definition ByteIO.h:60
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const String *value)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, DComplex *value)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Int *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Complex *value)
casacore::CanonicalIO::CanonicalIO
CanonicalIO(const std::shared_ptr< ByteIO > &byteIO, uInt bufferLength=4096)
Constructor.
casacore::CanonicalIO::CanonicalIO
CanonicalIO(const CanonicalIO &canonicalIO)
The copy constructor uses reference semantics.
casacore::CanonicalIO::itsBufferLength
uInt itsBufferLength
Definition CanonicalIO.h:135
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Int64 *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Int64 *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const uChar *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const uInt *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Complex *value)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Double *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Short *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, uInt *data)
casacore::CanonicalIO::~CanonicalIO
~CanonicalIO()
Destructor, deletes allocated memory.
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, uShort *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Char *data)
casacore::CanonicalIO::itsBuffer
char * itsBuffer
Definition CanonicalIO.h:134
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const DComplex *value)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const uInt64 *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Bool *value)
Convert the values and write them to the ByteIO object.
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Float *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, uInt64 *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Bool *value)
Read the values from the ByteIO object and convert them.
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, String *value)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Short *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Int *data)
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, uChar *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Double *data)
casacore::CanonicalIO::operator=
CanonicalIO & operator=(const CanonicalIO &canonicalIO)
The assignment operator uses reference semantics.
casacore::CanonicalIO::read
virtual size_t read(size_t nvalues, Char *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const uShort *data)
casacore::CanonicalIO::write
virtual size_t write(size_t nvalues, const Float *data)
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TypeIO::byteIO
const ByteIO & byteIO() const
Functions to return a reference to the ByteIO class.
casacore::TypeIO::TypeIO
TypeIO(const std::shared_ptr< ByteIO > &byteIO)
Constructor.
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uChar
unsigned char uChar
Definition aipstype.h:45
casacore::Short
short Short
Definition aipstype.h:46
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::uShort
unsigned short uShort
Definition aipstype.h:47
casacore::Int64
long long Int64
Define the extra non-standard types used by Casacore (like proposed uSize, Size).
Definition aipsxtype.h:36
casacore::Float
float Float
Definition aipstype.h:52
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::value
NewDelAllocator< T > NewDelAllocator< T >::value
Definition Allocator.h:368
casacore::Double
double Double
Definition aipstype.h:53
casacore::Char
char Char
Definition aipstype.h:44
casacore::uInt64
unsigned long long uInt64
Definition aipsxtype.h:37