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

Class for read-only access to data in a given format. More...

#include <ByteSource.h>

Inheritance diagram for casacore::ByteSource:
casacore::BaseSinkSource casacore::ByteSinkSource

Public Member Functions

 ByteSource ()
 Default constructor. More...
 
 ByteSource (TypeIO *typeIO, Bool takeOver=False)
 Construct from given TypeIO object. More...
 
 ByteSource (const ByteSource &source)
 The copy constructor uses reference semantics. More...
 
ByteSourceoperator= (const ByteSource &source)
 The assignment operator uses reference semantics. More...
 
 ~ByteSource ()
 destructor More...
 
ByteSourceoperator>> (Bool &value)
 These functions read one value of the given type. More...
 
ByteSourceoperator>> (Char &value)
 
ByteSourceoperator>> (uChar &value)
 
ByteSourceoperator>> (Short &value)
 
ByteSourceoperator>> (uShort &value)
 
ByteSourceoperator>> (Int &value)
 
ByteSourceoperator>> (uInt &value)
 
ByteSourceoperator>> (Int64 &value)
 
ByteSourceoperator>> (uInt64 &value)
 
ByteSourceoperator>> (Float &value)
 
ByteSourceoperator>> (Double &value)
 
ByteSourceoperator>> (Complex &value)
 
ByteSourceoperator>> (DComplex &value)
 
ByteSourceoperator>> (String &value)
 
void read (size_t nvalues, Bool *value)
 These functions read multiple values of the given type. More...
 
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)
 
- Public Member Functions inherited from casacore::BaseSinkSource
TypeIOtypeIO ()
 This functions returns a reference to itsTypeIO. More...
 
const TypeIOtypeIO () const
 
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 SinkSource readable? More...
 
Bool isWritable () const
 Is the SinkSource writable? More...
 
Bool isSeekable () const
 Is the SinkSource seekable? More...
 
Bool isNull () const
 Is the BaseSinkSource unusable? More...
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::BaseSinkSource
 BaseSinkSource ()
 
 BaseSinkSource (TypeIO *typeIO, Bool takeOver=False)
 Construct using the given TypeIO. More...
 
 BaseSinkSource (const BaseSinkSource &BaseSinkSource)
 The copy constructor uses reference semantics. More...
 
BaseSinkSourceoperator= (const BaseSinkSource &BaseSinkSource)
 The assignment operator uses reference semantics. More...
 
virtual ~BaseSinkSource ()
 
- Protected Attributes inherited from casacore::BaseSinkSource
CountedPtr< TypeIOitsTypeIO
 This variable keeps a pointer to a TypeIO. More...
 

Detailed Description

Class for read-only access to data in a given format.

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

A source is the place where bytes are read from.

Synopsis

ByteSource provides read-only access to a typed byte stream in the Casacore IO framework. The base class BaseSinkSource contains common functions like seek.

The object is constructed using a typed byte stream. This stream is an instance of a class derived from class TypeIO. This makes it possible to read the data in any format (e.g. CanonicalIO or RawIO).
In its turn TypeIO uses an instance of a class derived from class ByteIO. This makes it possible to use any input stream (e.g. file, memory).

Example

// Construct the correct input stream.
RegularFileIO filio ("file.name");
CanonicalIO canio (&filio);
ByteSource source (&canio);
// Read data.
Int vali;
Bool flag;
source >> vali >> flag;

Motivation

This class makes it possible to deny write-access to an IO stream.

Definition at line 91 of file ByteSource.h.

Constructor & Destructor Documentation

casacore::ByteSource::ByteSource ( )

Default constructor.

This creates an invalid object, but is present for convenience.

casacore::ByteSource::ByteSource ( TypeIO typeIO,
Bool  takeOver = False 
)

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.

casacore::ByteSource::ByteSource ( const ByteSource source)

The copy constructor uses reference semantics.

casacore::ByteSource::~ByteSource ( )

destructor

Member Function Documentation

ByteSource& casacore::ByteSource::operator= ( const ByteSource source)

The assignment operator uses reference semantics.

ByteSource& casacore::ByteSource::operator>> ( Bool value)

These functions read one value of the given type.

If this function does not succeed, an exception will be thrown.

ByteSource& casacore::ByteSource::operator>> ( Char value)
ByteSource& casacore::ByteSource::operator>> ( uChar value)
ByteSource& casacore::ByteSource::operator>> ( Short value)
ByteSource& casacore::ByteSource::operator>> ( uShort value)
ByteSource& casacore::ByteSource::operator>> ( Int value)
ByteSource& casacore::ByteSource::operator>> ( uInt value)
ByteSource& casacore::ByteSource::operator>> ( Int64 value)
ByteSource& casacore::ByteSource::operator>> ( uInt64 value)
ByteSource& casacore::ByteSource::operator>> ( Float value)
ByteSource& casacore::ByteSource::operator>> ( Double value)
ByteSource& casacore::ByteSource::operator>> ( Complex &  value)
ByteSource& casacore::ByteSource::operator>> ( DComplex &  value)
ByteSource& casacore::ByteSource::operator>> ( String value)
void casacore::ByteSource::read ( size_t  nvalues,
Bool value 
)

These functions read multiple values of the given type.

If this function does not succeed, an exception will be thrown.

void casacore::ByteSource::read ( size_t  nvalues,
Char value 
)
void casacore::ByteSource::read ( size_t  nvalues,
uChar value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Short value 
)
void casacore::ByteSource::read ( size_t  nvalues,
uShort value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Int value 
)
void casacore::ByteSource::read ( size_t  nvalues,
uInt value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Int64 value 
)
void casacore::ByteSource::read ( size_t  nvalues,
uInt64 value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Float value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Double value 
)
void casacore::ByteSource::read ( size_t  nvalues,
Complex *  value 
)
void casacore::ByteSource::read ( size_t  nvalues,
DComplex *  value 
)
void casacore::ByteSource::read ( size_t  nvalues,
String value 
)

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