casacore::ConversionIO Class Reference

Class for IO in a converted format. More...

#include <ConversionIO.h>

Inheritance diagram for casacore::ConversionIO:

Public Member Functions
	ConversionIO (DataConversion dataConversion, ByteIO byteIO, uInt bufferLength=4096, Bool takeOver=False)
	Constructor.
	ConversionIO (const ConversionIO &conversionIO)
	The copy constructor uses reference semantics.
ConversionIO &	operator= (const ConversionIO &conversionIO)
	The assignment operator uses reference semantics.
	~ConversionIO ()
	Destructor, deletes allocated memory.
virtual size_t	write (size_t nvalues, const Bool *value)
	Convert the values and write them to the ByteIO object.
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)
virtual size_t	read (size_t nvalues, Bool *value)
	Read the values from the ByteIO object and convert them.
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)
Private Member Functions
void	init ()
	Initialize the `itsSize` and `itsCopy` variables.
Private Attributes
CountedPtr< DataConversion >	itsConversion
uInt	itsSizeChar
uInt	itsSizeuChar
uInt	itsSizeShort
uInt	itsSizeuShort
uInt	itsSizeInt
uInt	itsSizeuInt
uInt	itsSizeInt64
uInt	itsSizeuInt64
uInt	itsSizeFloat
uInt	itsSizeDouble
Bool	itsCopyChar
Bool	itsCopyuChar
Bool	itsCopyShort
Bool	itsCopyuShort
Bool	itsCopyInt
Bool	itsCopyuInt
Bool	itsCopyInt64
Bool	itsCopyuInt64
Bool	itsCopyFloat
Bool	itsCopyDouble
char *	itsBuffer
uInt	itsBufferLength

Detailed Description

Class for IO in a converted format.

Intended use:

Public interface

Review Status

Reviewed By:: Friso Olnon
Date Reviewed:: 1996/11/06
Test programs:: tTypeIO

Prerequisite

ByteIO class and derived classes
TypeIO class
DataConversion

Synopsis

ConversionIO is a specialization of class TypeIO to store data in a converted format.

The class converts the data to/from external 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.

This class is useful when data can be stored in one of multiple formats. Only at construction time the correct DataConversion class has to be given. Thereafter polymorphism ensures that the correct conversion is done when reading or writing.

Definition at line 74 of file ConversionIO.h.

Constructor & Destructor Documentation

casacore::ConversionIO::ConversionIO	(	DataConversion *	dataConversion,
		ByteIO *	byteIO,
		uInt	bufferLength = `4096`,
		Bool	takeOver = `False`
	)

Constructor.

The read/write functions will use the given ByteIO object as the data store and the given DataConversion object as the conversion engine.

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 bufferLength. For arrays not fitting in this buffer, it uses a temporary buffer allocated on the heap.

If takeOver is True this this class will be responsible for deleting the DataConversion and ByteIO pointers. Otherwise it is the callers responsibility.

casacore::ConversionIO::ConversionIO ( const ConversionIO & conversionIO )

The copy constructor uses reference semantics.

casacore::ConversionIO::~ConversionIO ( )

Destructor, deletes allocated memory.

Member Function Documentation

void casacore::ConversionIO::init ( ) [private]

Initialize the itsSize and itsCopy variables.

ConversionIO& casacore::ConversionIO::operator= ( const ConversionIO & conversionIO )

The assignment operator uses reference semantics.

Reimplemented from casacore::TypeIO.

virtual size_t casacore::ConversionIO::read	(	size_t	nvalues,
		String *	value
	)			`[virtual]`

Reimplemented from casacore::TypeIO.

virtual size_t casacore::ConversionIO::read	(	size_t	nvalues,
		DComplex *	value
	)			`[virtual]`

Reimplemented from casacore::TypeIO.

virtual size_t casacore::ConversionIO::read	(	size_t	nvalues,
		Complex *	value
	)			`[virtual]`

Reimplemented from casacore::TypeIO.

virtual size_t casacore::ConversionIO::read	(	size_t	nvalues,
		Double *	data
	)			`[virtual]`

virtual size_t casacore::ConversionIO::write	(	size_t	nvalues,
		const String *	value
	)			`[virtual]`

casacore::ConversionIO Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation