vil_stream_url Class Reference

open an URL. More...

#include <vil_stream_url.h>

Inheritance diagram for vil_stream_url:

List of all members.

Public Member Functions
	vil_stream_url (char const *)
	~vil_stream_url ()
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 ()
Private Member Functions
	vil_stream_url (vil_stream_url const &)
vil_stream_url &	operator= (vil_stream_url const &)
Private Attributes
vil_stream *	u_
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

open an URL.

Definition at line 16 of file vil_stream_url.h.

---

Constructor & Destructor Documentation

vil_stream_url::vil_stream_url

(

vil_stream_url const &

)

[inline, private]

Definition at line 21 of file vil_stream_url.h.

vil_stream_url::vil_stream_url

(

char const *

url

)

Definition at line 117 of file vil_stream_url.cxx.

vil_stream_url::~vil_stream_url

(

)

Definition at line 322 of file vil_stream_url.cxx.

---

Member Function Documentation

vil_streampos vil_stream_url::file_size

(

)

const [inline, virtual]

Amount of data in the stream.

Implements vil_stream.

Definition at line 35 of file vil_stream_url.h.

bool vil_stream_url::ok

(

)

const [inline, virtual]

Return false if the stream is broken.

Implements vil_stream.

Definition at line 28 of file vil_stream_url.h.

vil_stream_url& vil_stream_url::operator=

(

vil_stream_url const &

)

[inline, private]

Definition at line 22 of file vil_stream_url.h.

vil_streampos vil_stream_url::read	(	void *	buf,
		vil_streampos	n
	)		[inline, 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 31 of file vil_stream_url.h.

void vil_stream::ref

(

)

[inline, inherited]

up/down the reference count.

Definition at line 48 of file vil_stream.h.

void vil_stream_url::seek

(

vil_streampos

position

)

[inline, virtual]

Goto file pointer.

Implements vil_stream.

Definition at line 33 of file vil_stream_url.h.

vil_streampos vil_stream_url::tell

(

)

const [inline, virtual]

Return file pointer.

Implements vil_stream.

Definition at line 32 of file vil_stream_url.h.

void vil_stream::unref

(

)

[inherited]

Definition at line 31 of file vil_stream.cxx.

vil_streampos vil_stream_url::write	(	void const *	buf,
		vil_streampos	n
	)		[inline, 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 29 of file vil_stream_url.h.

---

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_stream* vil_stream_url::u_ [private]

Definition at line 18 of file vil_stream_url.h.

---

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

• core/vil/vil_stream_url.h
• core/vil/vil_stream_url.cxx