make a section of a vil_stream behave like a vil_stream. More...
#include <vil_stream_section.h>
Public Member Functions | |
| vil_stream_section (vil_stream *underlying, int begin) | |
| skip to position 'begin' in underlying stream and translate seeks, reads and writes relative to that position into seeks, reads and writes in the underlying stream. | |
| vil_stream_section (vil_stream *underlying, int begin, int end) | |
| as above, but will not allow seeks, reads or writes past 'end'. | |
| bool | ok () const |
| Return false if the stream is broken. | |
| vil_streampos | write (void const *buf, vil_streampos n) |
| Write n bytes from buf. Returns number of bytes written. | |
| vil_streampos | read (void *buf, vil_streampos n) |
| Read n bytes into buf. Returns number of bytes read. | |
| vil_streampos | tell () const |
| Return file pointer. | |
| void | seek (vil_streampos position) |
| Goto file pointer. | |
| vil_streampos | file_size () const |
| Amount of data in the stream. | |
| void | ref () |
| up/down the reference count. | |
| void | unref () |
Protected Member Functions | |
| ~vil_stream_section () | |
Private Attributes | |
| vil_stream * | underlying_ |
| vil_streampos | begin_ |
| vil_streampos | end_ |
| vil_streampos | current_ |
Related Functions | |
(Note that these are not member functions.) | |
| vil_stream * | vil_open (char const *what, char const *how="r") |
| make a vil_stream from a filename, an URL, etc. | |
| float | vil_stream_read_big_endian_float (vil_stream *is) |
| Reads in a 4-byte big-endian float. | |
| void | vil_stream_read_big_endian_int_16 (vil_stream *is, vxl_uint_16 *data, unsigned n) |
| Reads in n 16 bit unsigned ints. | |
| void | vil_stream_write_big_endian_uint_16 (vil_stream *, vxl_uint_16) |
| void | vil_stream_write_little_endian_uint_16 (vil_stream *, vxl_uint_16) |
| void | vil_stream_write_big_endian_uint_32 (vil_stream *, vxl_uint_32) |
| void | vil_stream_write_little_endian_uint_32 (vil_stream *, vxl_uint_32) |
Detailed Description
make a section of a vil_stream behave like a vil_stream.
It is possible to have multiple vil_stream_sections using the same underlying stream simultaneously. This is accomplished by keeping a note of the current position and seeking a lot.
Note however that this is not threadsafe.
Definition at line 21 of file vil_stream_section.h.
Constructor & Destructor Documentation
| vil_stream_section::vil_stream_section | ( | vil_stream * | underlying, |
| int | begin | ||
| ) |
skip to position 'begin' in underlying stream and translate seeks, reads and writes relative to that position into seeks, reads and writes in the underlying stream.
Definition at line 18 of file vil_stream_section.cxx.
| vil_stream_section::vil_stream_section | ( | vil_stream * | underlying, |
| int | begin, | ||
| int | end | ||
| ) |
as above, but will not allow seeks, reads or writes past 'end'.
Definition at line 29 of file vil_stream_section.cxx.
| vil_stream_section::~vil_stream_section | ( | ) | [protected] |
Definition at line 41 of file vil_stream_section.cxx.
Member Function Documentation
| vil_streampos vil_stream_section::file_size | ( | ) | const [virtual] |
Amount of data in the stream.
Implements vil_stream.
Definition at line 116 of file vil_stream_section.cxx.
| bool vil_stream_section::ok | ( | ) | const [inline, virtual] |
Return false if the stream is broken.
Implements vil_stream.
Definition at line 34 of file vil_stream_section.h.
| vil_streampos vil_stream_section::read | ( | void * | buf, |
| vil_streampos | n | ||
| ) | [virtual] |
Read n bytes into buf. Returns number of bytes read.
The return value is less than n only at eof.
Implements vil_stream.
Definition at line 77 of file vil_stream_section.cxx.
| void vil_stream::ref | ( | ) | [inline, inherited] |
up/down the reference count.
Definition at line 48 of file vil_stream.h.
| void vil_stream_section::seek | ( | vil_streampos | position | ) | [virtual] |
| vil_streampos vil_stream_section::tell | ( | ) | const [inline, virtual] |
| void vil_stream::unref | ( | ) | [inherited] |
Definition at line 31 of file vil_stream.cxx.
| vil_streampos vil_stream_section::write | ( | void const * | buf, |
| vil_streampos | n | ||
| ) | [virtual] |
Write n bytes from buf. Returns number of bytes written.
The return value is less than n only in case of device failure.
Implements vil_stream.
Definition at line 50 of file vil_stream_section.cxx.
Friends And Related Function Documentation
| vil_stream * vil_open | ( | char const * | what, |
| char const * | how = "r" |
||
| ) | [related] |
make a vil_stream from a filename, an URL, etc.
Definition at line 19 of file vil_open.cxx.
| float vil_stream_read_big_endian_float | ( | vil_stream * | is | ) | [related] |
Reads in a 4-byte big-endian float.
Definition at line 109 of file vil_stream_read.cxx.
| void vil_stream_read_big_endian_int_16 | ( | vil_stream * | is, |
| vxl_uint_16 * | data, | ||
| unsigned | n | ||
| ) | [related] |
Reads in n 16 bit unsigned ints.
Caller is responsible for allocating enough space.
Definition at line 121 of file vil_stream_read.cxx.
| void vil_stream_write_big_endian_uint_16 | ( | vil_stream * | , |
| vxl_uint_16 | |||
| ) | [related] |
Definition at line 17 of file vil_stream_write.cxx.
| void vil_stream_write_big_endian_uint_32 | ( | vil_stream * | , |
| vxl_uint_32 | |||
| ) | [related] |
Definition at line 33 of file vil_stream_write.cxx.
| void vil_stream_write_little_endian_uint_16 | ( | vil_stream * | , |
| vxl_uint_16 | |||
| ) | [related] |
Definition at line 25 of file vil_stream_write.cxx.
| void vil_stream_write_little_endian_uint_32 | ( | vil_stream * | , |
| vxl_uint_32 | |||
| ) | [related] |
Definition at line 43 of file vil_stream_write.cxx.
Member Data Documentation
vil_streampos vil_stream_section::begin_ [private] |
Definition at line 47 of file vil_stream_section.h.
vil_streampos vil_stream_section::current_ [private] |
Definition at line 49 of file vil_stream_section.h.
vil_streampos vil_stream_section::end_ [private] |
Definition at line 48 of file vil_stream_section.h.
vil_stream* vil_stream_section::underlying_ [private] |
Definition at line 46 of file vil_stream_section.h.
The documentation for this struct was generated from the following files:
- core/vil/vil_stream_section.h
- core/vil/vil_stream_section.cxx
