casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casacore::RawIO Class Reference
IO_module

Class for IO in local format. More...

#include <RawIO.h>

Inheritance diagram for casacore::RawIO:
casacore::TypeIO

Public Member Functions

 RawIO (ByteIO *byteIO, Bool takeOver=False)
 Constructor. More...
 
 RawIO (const RawIO &rawIO)
 The copy constructor uses reference semantics. More...
 
RawIO & operator= (const RawIO &rawIO)
 The assignment operator uses reference semantics. More...
 
 ~RawIO ()
 Destructor. More...
 
virtual size_t write (size_t nvalues, const Bool *value)
 Write the values to the ByteIO object. More...
 
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. More...
 
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)
 
- Public Member Functions inherited from casacore::TypeIO
 TypeIO (ByteIO *byteIO, Bool takeOver=False)
 Constructor. More...
 
virtual ~TypeIO ()
 
const ByteIO & byteIO () const
 Functions to return a reference to the ByteIO class. More...
 
ByteIO & byteIO ()
 
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...
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::TypeIO
 TypeIO (const TypeIO &TypeIO)
 The copy constructor uses reference semantics. More...
 
TypeIO & operator= (const TypeIO &typeIO)
 The assignment operator uses reference semantics. More...
 
- Protected Attributes inherited from casacore::TypeIO
CountedPtr< ByteIO > itsByteIO
 This variable keeps a pointer to a ByteIO. More...
 

Detailed Description

Class for IO in local format.

Intended use:

Public interface

Review Status

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

Prerequisite

Synopsis

RawIO is a specialization of class TypeIO to store data in local format.

This class is intended for data that will only be used internally and will not be exported to machines with a possible different data format.

To save storage Bools will be written as bits (using the static functions in class Conversion.

Motivation

Storing data in local format can improve performance on little-endian machines like DEC-alpha and PC's.

Definition at line 73 of file RawIO.h.

Constructor & Destructor Documentation

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

Constructor.

The read/write functions will use the given ByteIO object as the data store. If takeOver is True the this class will delete the supplied pointer. Otherwise the caller is responsible for this.

casacore::RawIO::RawIO ( const RawIO &  rawIO)

The copy constructor uses reference semantics.

casacore::RawIO::~RawIO ( )

Destructor.

Member Function Documentation

RawIO& casacore::RawIO::operator= ( const RawIO &  rawIO)

The assignment operator uses reference semantics.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Bool *  value 
)
virtual

Read the values from the ByteIO object.

Bool, complex and String values are handled by the base class.

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Char *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
uChar *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Short *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
uShort *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Int *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
uInt *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Int64 *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
uInt64 *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Float *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Double *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
Complex *  value 
)
virtual

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
DComplex *  value 
)
virtual

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::read ( size_t  nvalues,
String *  value 
)
virtual

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Bool *  value 
)
virtual

Write the values to the ByteIO object.

Bool, complex and String values are handled by the base class.

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Char *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const uChar *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Short *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const uShort *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Int *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const uInt *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Int64 *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const uInt64 *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Float *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Double *  data 
)
virtual

Implements casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const Complex *  value 
)
virtual

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const DComplex *  value 
)
virtual

Reimplemented from casacore::TypeIO.

virtual size_t casacore::RawIO::write ( size_t  nvalues,
const String *  value 
)
virtual

Reimplemented from casacore::TypeIO.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5