vil1_stream Class Reference

#include <vil1_stream.h>

Inheritance diagram for vil1_stream:

List of all members.

---

Detailed Description

Stream interface for VIL image loaders.

This allows the loaders to be used with any type of stream.

Definition at line 17 of file vil1_stream.h.

Public Member Functions
virtual bool	ok () const=0
	Return false if the stream is broken.
virtual vil1_streampos	write (void const *buf, vil1_streampos n)=0
	Write n bytes from buf. Returns number of bytes written.
virtual vil1_streampos	read (void *buf, vil1_streampos n)=0
	Read n bytes into buf. Returns number of bytes read.
virtual vil1_streampos	tell () const=0
	Return file pointer.
virtual void	seek (vil1_streampos position)=0
	Goto file pointer.
void	ref ()
	up/down the reference count.
void	unref ()
Protected Member Functions
	vil1_stream ()
virtual	~vil1_stream ()
Private Attributes
int	refcount_

---

Constructor & Destructor Documentation

vil1_stream::vil1_stream

(

)

[protected]

Definition at line 15 of file vil1_stream.cxx.

vil1_stream::~vil1_stream

(

)

[protected, virtual]

Definition at line 23 of file vil1_stream.cxx.

---

Member Function Documentation

virtual bool vil1_stream::ok

(

)

const [pure virtual]

Return false if the stream is broken.

Implemented in vil1_stream_core, vil1_stream_fstream, vil1_stream_section, and vil1_stream_url.

virtual vil1_streampos vil1_stream::write	(	void const *	buf,
		vil1_streampos	n
	)			[pure virtual]

Write n bytes from buf. Returns number of bytes written.

The return value is less than n only in case of device failure.

Implemented in vil1_stream_core, vil1_stream_fstream, vil1_stream_section, and vil1_stream_url.

virtual vil1_streampos vil1_stream::read	(	void *	buf,
		vil1_streampos	n
	)			[pure virtual]

Read n bytes into buf. Returns number of bytes read.

The return value is less than n only at eof.

Implemented in vil1_stream_core, vil1_stream_fstream, vil1_stream_section, and vil1_stream_url.

virtual vil1_streampos vil1_stream::tell

(

)

const [pure virtual]

Return file pointer.

Implemented in vil1_stream_core, vil1_stream_fstream, vil1_stream_section, and vil1_stream_url.

virtual void vil1_stream::seek

(

vil1_streampos

position

)

[pure virtual]

Goto file pointer.

Implemented in vil1_stream_core, vil1_stream_fstream, vil1_stream_section, and vil1_stream_url.

void vil1_stream::ref

(

)

[inline]

up/down the reference count.

Definition at line 38 of file vil1_stream.h.

void vil1_stream::unref

(

)

Definition at line 31 of file vil1_stream.cxx.

---

Member Data Documentation

int vil1_stream::refcount_ [private]

Definition at line 46 of file vil1_stream.h.

---

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

• core/vil1/vil1_stream.h
• core/vil1/vil1_stream.cxx

---