Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ISubStream Class Reference

An istream object that presents a subwindow into another istream. More...

#include <subStream.h>

List of all members.

Public Member Functions

 ISubStream ()
 ISubStream (istream *source, streampos start, streampos end)
ISubStream & open (istream *source, streampos start, streampos end)
 Starts the SubStream reading from the indicated source, with the first character being the character at position "start" within the source, for end - start total characters.

ISubStream & close ()
 Resets the SubStream to empty, but does not actually close the source istream.


Private Attributes

SubStreamBuf _buf

Detailed Description

An istream object that presents a subwindow into another istream.

The first character read from this stream will be the "start" character from the source istream; just before the file pointer reaches the "end" character, eof is returned.

The source stream must be one that we can randomly seek within. The resulting ISubStream will also support arbitrary seeks.

Definition at line 51 of file subStream.h.

Constructor & Destructor Documentation

ISubStream::ISubStream (   )  [inline]
 

Definition at line 31 of file subStream.I.

References INLINE, and open().

ISubStream::ISubStream (  istream *  source,
streampos  start,
streampos  end
)  [inline]
 

Definition at line 42 of file subStream.I.

References _buf, INLINE, ios_iostate, and SubStreamBuf::open().

Member Function Documentation

ISubStream & ISubStream::close (   )  [inline]
 

Resets the SubStream to empty, but does not actually close the source istream.

Definition at line 88 of file subStream.I.

ISubStream & ISubStream::open (  istream *  source,
streampos  start,
streampos  end
)  [inline]
 

Starts the SubStream reading from the indicated source, with the first character being the character at position "start" within the source, for end - start total characters.

The character at "end" within the source will never be read; this will appear to be EOF.

If end is zero, it indicates that the ISubStream will continue until the end of the source stream.

Definition at line 71 of file subStream.I.

Referenced by ISubStream().

Member Data Documentation

SubStreamBuf ISubStream::_buf [private]
 

Definition at line 60 of file subStream.h.

Referenced by ISubStream().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:51:36 2003 for Panda by doxygen1.3