Public Member Functions | Protected Member Functions | Private Attributes | Related Functions | List of all members
vil_stream_fstream Class Reference

A vil_stream implementation using std::fstream. More...

#include <vil_stream_fstream.h>

Inheritance diagram for vil_stream_fstream:
Inheritance graph
[legend]

Public Member Functions

 vil_stream_fstream (char const *filename, char const *mode)
 
bool ok () const override
 Return false if the stream is broken. More...
 
vil_streampos write (void const *buf, vil_streampos n) override
 Write n bytes from buf. Returns number of bytes written. More...
 
vil_streampos read (void *buf, vil_streampos n) override
 Read n bytes into buf. Returns number of bytes read. More...
 
vil_streampos tell () const override
 Return file pointer. More...
 
void seek (vil_streampos position) override
 Goto file pointer. More...
 
vil_streampos file_size () const override
 Amount of data in the stream. More...
 
void ref ()
 up/down the reference count. More...
 
void unref ()
 

Protected Member Functions

 ~vil_stream_fstream () override
 
std::fstream & underlying_stream ()
 

Private Attributes

std::ios::openmode flags_
 
std::fstream f_
 
int id_
 
vil_streampos end_
 

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. More...
 
float vil_stream_read_big_endian_float (vil_stream *is)
 Reads in a 4-byte big-endian float. More...
 
void vil_stream_read_big_endian_int_16 (vil_stream *is, vxl_uint_16 *data, unsigned n)
 Reads in n 16 bit unsigned ints. More...
 
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)
 
void vil_stream_write_big_endian_int_32 (vil_stream *, vxl_int_32)
 
void vil_stream_write_little_endian_int_32 (vil_stream *, vxl_int_32)
 

Detailed Description

A vil_stream implementation using std::fstream.

Definition at line 23 of file vil_stream_fstream.h.

Constructor & Destructor Documentation

◆ vil_stream_fstream()

vil_stream_fstream::vil_stream_fstream ( char const *  filename,
char const *  mode 
)

Definition at line 39 of file vil_stream_fstream.cxx.

◆ ~vil_stream_fstream()

vil_stream_fstream::~vil_stream_fstream ( )
overrideprotected

Definition at line 71 of file vil_stream_fstream.cxx.

Member Function Documentation

◆ file_size()

vil_streampos vil_stream_fstream::file_size ( ) const
overridevirtual

Amount of data in the stream.

Implements vil_stream.

Definition at line 186 of file vil_stream_fstream.cxx.

◆ ok()

bool vil_stream_fstream::ok ( ) const
inlineoverridevirtual

Return false if the stream is broken.

Implements vil_stream.

Definition at line 33 of file vil_stream_fstream.h.

◆ read()

vil_streampos vil_stream_fstream::read ( void *  buf,
vil_streampos  n 
)
overridevirtual

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 98 of file vil_stream_fstream.cxx.

◆ ref()

void vil_stream::ref ( )
inlineinherited

up/down the reference count.

Definition at line 45 of file vil_stream.h.

◆ seek()

void vil_stream_fstream::seek ( vil_streampos  position)
overridevirtual

Goto file pointer.

Implements vil_stream.

Definition at line 147 of file vil_stream_fstream.cxx.

◆ tell()

vil_streampos vil_stream_fstream::tell ( ) const
overridevirtual

Return file pointer.

Implements vil_stream.

Definition at line 130 of file vil_stream_fstream.cxx.

◆ underlying_stream()

std::fstream& vil_stream_fstream::underlying_stream ( )
inlineprotected

Definition at line 45 of file vil_stream_fstream.h.

◆ unref()

void vil_stream::unref ( )
inherited

Definition at line 31 of file vil_stream.cxx.

◆ write()

vil_streampos vil_stream_fstream::write ( void const *  buf,
vil_streampos  n 
)
overridevirtual

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 76 of file vil_stream_fstream.cxx.

Friends And Related Function Documentation

◆ vil_open()

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 18 of file vil_open.cxx.

◆ vil_stream_read_big_endian_float()

float vil_stream_read_big_endian_float ( vil_stream *  is)
related

Reads in a 4-byte big-endian float.

Definition at line 122 of file vil_stream_read.cxx.

◆ vil_stream_read_big_endian_int_16()

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 134 of file vil_stream_read.cxx.

◆ vil_stream_write_big_endian_int_32()

void vil_stream_write_big_endian_int_32 ( vil_stream *  ,
vxl_int_32   
)
related

Definition at line 50 of file vil_stream_write.cxx.

◆ vil_stream_write_big_endian_uint_16()

void vil_stream_write_big_endian_uint_16 ( vil_stream *  ,
vxl_uint_16   
)
related

Definition at line 14 of file vil_stream_write.cxx.

◆ vil_stream_write_big_endian_uint_32()

void vil_stream_write_big_endian_uint_32 ( vil_stream *  ,
vxl_uint_32   
)
related

Definition at line 30 of file vil_stream_write.cxx.

◆ vil_stream_write_little_endian_int_32()

void vil_stream_write_little_endian_int_32 ( vil_stream *  ,
vxl_int_32   
)
related

Definition at line 60 of file vil_stream_write.cxx.

◆ vil_stream_write_little_endian_uint_16()

void vil_stream_write_little_endian_uint_16 ( vil_stream *  ,
vxl_uint_16   
)
related

Definition at line 22 of file vil_stream_write.cxx.

◆ vil_stream_write_little_endian_uint_32()

void vil_stream_write_little_endian_uint_32 ( vil_stream *  ,
vxl_uint_32   
)
related

Definition at line 40 of file vil_stream_write.cxx.

Member Data Documentation

◆ end_

vil_streampos vil_stream_fstream::end_
mutableprivate

Definition at line 50 of file vil_stream_fstream.h.

◆ f_

std::fstream vil_stream_fstream::f_
mutableprivate

Definition at line 48 of file vil_stream_fstream.h.

◆ flags_

std::ios::openmode vil_stream_fstream::flags_
private

Definition at line 47 of file vil_stream_fstream.h.

◆ id_

int vil_stream_fstream::id_
private

Definition at line 49 of file vil_stream_fstream.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15