casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
casacore::TypeIO Class Referenceabstract

Abstract base class for IO of data in a type-dependent format. More...

#include <TypeIO.h>

Inheritance diagram for casacore::TypeIO:
casacore::CanonicalIO casacore::ConversionIO casacore::LECanonicalIO casacore::RawIO

Public Member Functions

 TypeIO (ByteIO *byteIO, Bool takeOver=False)
 Constructor. More...
 
virtual ~TypeIO ()
 
const ByteIObyteIO () const
 Functions to return a reference to the ByteIO class. More...
 
ByteIObyteIO ()
 
virtual size_t write (size_t nvalues, const Bool *value)
 Convert the values and write them to the ByteIO object. More...
 
virtual size_t write (size_t nvalues, const Char *value)=0
 
virtual size_t write (size_t nvalues, const uChar *value)=0
 
virtual size_t write (size_t nvalues, const Short *value)=0
 
virtual size_t write (size_t nvalues, const uShort *value)=0
 
virtual size_t write (size_t nvalues, const Int *value)=0
 
virtual size_t write (size_t nvalues, const uInt *value)=0
 
virtual size_t write (size_t nvalues, const Int64 *value)=0
 
virtual size_t write (size_t nvalues, const uInt64 *value)=0
 
virtual size_t write (size_t nvalues, const Float *value)=0
 
virtual size_t write (size_t nvalues, const Double *value)=0
 
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. More...
 
virtual size_t read (size_t nvalues, Char *value)=0
 
virtual size_t read (size_t nvalues, uChar *value)=0
 
virtual size_t read (size_t nvalues, Short *value)=0
 
virtual size_t read (size_t nvalues, uShort *value)=0
 
virtual size_t read (size_t nvalues, Int *value)=0
 
virtual size_t read (size_t nvalues, uInt *value)=0
 
virtual size_t read (size_t nvalues, Int64 *value)=0
 
virtual size_t read (size_t nvalues, uInt64 *value)=0
 
virtual size_t read (size_t nvalues, Float *value)=0
 
virtual size_t read (size_t nvalues, Double *value)=0
 
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)
 
Int64 seek (Int64 offset, ByteIO::SeekOption=ByteIO::Begin)
 This function sets the position on the given offset. More...
 
Int64 seek (Int offset, ByteIO::SeekOption=ByteIO::Begin)
 
Bool isReadable () const
 Is the TypeIO stream readable? More...
 
Bool isWritable () const
 Is the TypeIO stream writable? More...
 
Bool isSeekable () const
 Is the TypeIO stream seekable? More...
 

Protected Member Functions

 TypeIO (const TypeIO &TypeIO)
 The copy constructor uses reference semantics. More...
 
TypeIOoperator= (const TypeIO &typeIO)
 The assignment operator uses reference semantics. More...
 

Protected Attributes

CountedPtr< ByteIOitsByteIO
 This variable keeps a pointer to a ByteIO. More...
 

Detailed Description

Abstract base class for IO of data in a type-dependent format.

Intended use:

Public interface

Review Status

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

Prerequisite

Synopsis

This class is the abstract base class for doing IO in a type-dependent way. Derived from it are classes like CanonicalIO doing the actual formatting of the data.

The TypeIO classes convert the data to/from the given format using the static conversion functions in the classes like CanonicalConversion. The data is written to or read from the ByteIO object given when constructing the TypeIO object.

TypeIO declares the virtual functions read and write to read/write one or more values of a given data type. Usually the derived classes have to implement these functions. An exception are the functions handling Bool, complex and String values. These functions have a default implementation in this base class. However, if needed they can be overwritten in derived classes.

Motivation

The base class is needed for polymorphic type-dependent IO. Furthermore the common functionality can be implemented here.

Definition at line 79 of file TypeIO.h.

Constructor & Destructor Documentation

casacore::TypeIO::TypeIO ( ByteIO byteIO,
Bool  takeOver = False 
)
explicit

Constructor.

The read/write functions will use the given ByteIO object as the data store.

virtual casacore::TypeIO::~TypeIO ( )
virtual
casacore::TypeIO::TypeIO ( const TypeIO TypeIO)
protected

The copy constructor uses reference semantics.

Member Function Documentation

const ByteIO& casacore::TypeIO::byteIO ( ) const

Functions to return a reference to the ByteIO class.

ByteIO& casacore::TypeIO::byteIO ( )
Bool casacore::TypeIO::isReadable ( ) const

Is the TypeIO stream readable?

Bool casacore::TypeIO::isSeekable ( ) const

Is the TypeIO stream seekable?

Bool casacore::TypeIO::isWritable ( ) const

Is the TypeIO stream writable?

TypeIO& casacore::TypeIO::operator= ( const TypeIO typeIO)
protected

The assignment operator uses reference semantics.

virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Bool value 
)
virtual

Read the values from the ByteIO object and convert them.

By default Bools are stored as bits, Complex as 2 floats, DComplex as 2 doubles and String as a length (uInt) and chars. If it does not succeed an exception will be thrown.

Reimplemented in casacore::ConversionIO, casacore::CanonicalIO, casacore::LECanonicalIO, and casacore::RawIO.

Referenced by casacore::StManArrayFile::get().

virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Char value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
uChar value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Short value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
uShort value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Int value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
uInt value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Int64 value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
uInt64 value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Float value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Double value 
)
pure virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
Complex *  value 
)
virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
DComplex *  value 
)
virtual
virtual size_t casacore::TypeIO::read ( size_t  nvalues,
String value 
)
virtual
Int64 casacore::TypeIO::seek ( Int64  offset,
ByteIO::SeekOption  = ByteIO::Begin 
)

This function sets the position on the given offset.

The seek option defines from which file position the seek is done. -1 is returned if not seekable.

Int64 casacore::TypeIO::seek ( Int  offset,
ByteIO::SeekOption  = ByteIO::Begin 
)
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Bool value 
)
virtual

Convert the values and write them to the ByteIO object.

By default Bools are stored as bits, Complex as 2 floats, DComplex as 2 doubles and String as a length (uInt) and chars. If it does not succeed an exception will be thrown.

Reimplemented in casacore::ConversionIO, casacore::CanonicalIO, casacore::LECanonicalIO, and casacore::RawIO.

Referenced by casacore::StManArrayFile::put().

virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Char value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const uChar value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Short value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const uShort value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Int value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const uInt value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Int64 value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const uInt64 value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Float value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Double value 
)
pure virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const Complex *  value 
)
virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const DComplex *  value 
)
virtual
virtual size_t casacore::TypeIO::write ( size_t  nvalues,
const String value 
)
virtual

Member Data Documentation

CountedPtr<ByteIO> casacore::TypeIO::itsByteIO
protected

This variable keeps a pointer to a ByteIO.

Definition at line 156 of file TypeIO.h.


The documentation for this class was generated from the following file: