soma::IStreamDataSource Class Reference

DataSource on a std::istream (read-only stream) More...

#include <soma-io/datasource/streamdatasource.h>

Inheritance diagram for soma::IStreamDataSource:

Collaboration diagram for soma::IStreamDataSource:

Public Member Functions
	IStreamDataSource (std::istream &, const std::string &url=std::string())
	Using an existing, external stream. More...
	IStreamDataSource (carto::rc_ptr< std::istream >, const std::string &url=std::string())
	Using a ref-counter to a stream. More...
virtual	~IStreamDataSource ()
std::istream &	stream ()
virtual std::string	url () const
virtual DataSource *	clone () const
virtual bool	open (int mode)
virtual bool	allowsMemoryMapping () const
virtual int	iterateMode () const
	possible iteration mode(s): bitwise OR of IterateMode values More...
virtual bool	isOpen () const
virtual bool	eof () const
virtual bool	operator! () const
virtual void	close ()
virtual offset_t	size () const
	always returns 0 More...
virtual offset_t	at () const
virtual bool	at (offset_t pos)
virtual long	readBlock (char *data, unsigned long maxlen)
virtual long	writeBlock (const char *data, unsigned long len)
	always fails More...
virtual int	getch ()
virtual int	putch (int ch)
	always fails More...
virtual bool	ungetch (int ch)
bool	isFile () const
Public Member Functions inherited from soma::DataSource
	DataSource ()
virtual	~DataSource ()
int	mode () const
	access mode(s) (read/write): bitwise OR of Mode values More...
virtual	operator bool () const
virtual void	flush ()
virtual bool	atEnd () const
bool	reset ()
Public Member Functions inherited from carto::RCObject
	RCObject ()
	RCObject (const RCObject &)
RCObject &	operator= (const RCObject &)
virtual	~RCObject ()

Additional Inherited Members
Public Types inherited from soma::DataSource
enum	Mode { Read = 1 , Write = 2 , ReadWrite = 3 }
enum	IterateMode { DirectAccess = 1 , SequentialAccess = 2 }
Public Types inherited from carto::RCObject
typedef int	RefCounterType
Static Public Member Functions inherited from soma::DataSource
static const carto::rc_ptr< DataSource >	none ()
	An empty ref-counter that is more convenient than calling a constructor of rc_ptr<DataSource> (useful when calling functions) More...
Protected Attributes inherited from soma::DataSource
int	_mode

Detailed Description

DataSource on a std::istream (read-only stream)

Definition at line 95 of file streamdatasource.h.

Constructor & Destructor Documentation

IStreamDataSource() [1/2]

soma::IStreamDataSource::IStreamDataSource	(	std::istream &	,
		const std::string &	url = std::string()
	)

Using an existing, external stream.

IStreamDataSource() [2/2]

soma::IStreamDataSource::IStreamDataSource	(	carto::rc_ptr< std::istream >	,
		const std::string &	url = std::string()
	)

Using a ref-counter to a stream.

~IStreamDataSource()

virtual soma::IStreamDataSource::~IStreamDataSource ( )

virtual

Member Function Documentation

allowsMemoryMapping()

virtual bool soma::IStreamDataSource::allowsMemoryMapping ( ) const

virtual

Implements soma::DataSource.

at() [1/2]

virtual offset_t soma::IStreamDataSource::at ( ) const

virtual

Implements soma::DataSource.

at() [2/2]

virtual bool soma::IStreamDataSource::at ( offset_t  pos )

virtual

Implements soma::DataSource.

clone()

virtual DataSource* soma::IStreamDataSource::clone ( ) const

virtual

Implements soma::DataSource.

close()

virtual void soma::IStreamDataSource::close ( )

virtual

Implements soma::DataSource.

eof()

virtual bool soma::IStreamDataSource::eof ( ) const

virtual

Reimplemented from soma::DataSource.

getch()

virtual int soma::IStreamDataSource::getch ( )

virtual

Implements soma::DataSource.

isFile()

bool soma::IStreamDataSource::isFile

(

)

const

isOpen()

virtual bool soma::IStreamDataSource::isOpen ( ) const

virtual

Implements soma::DataSource.

iterateMode()

virtual int soma::IStreamDataSource::iterateMode ( ) const

virtual

possible iteration mode(s): bitwise OR of IterateMode values

Implements soma::DataSource.

open()

virtual bool soma::IStreamDataSource::open ( int  mode )

virtual

Implements soma::DataSource.

operator!()

virtual bool soma::IStreamDataSource::operator! ( ) const

virtual

Reimplemented from soma::DataSource.

putch()

virtual int soma::IStreamDataSource::putch ( int  ch )

virtual

always fails

Implements soma::DataSource.

readBlock()

virtual long soma::IStreamDataSource::readBlock ( char *  data, unsigned long  maxlen  )

virtual

Implements soma::DataSource.

size()

virtual offset_t soma::IStreamDataSource::size ( ) const

virtual

always returns 0

Implements soma::DataSource.

stream()

std::istream& soma::IStreamDataSource::stream

(

)

ungetch()

virtual bool soma::IStreamDataSource::ungetch ( int  ch )

virtual

Implements soma::DataSource.

url()

virtual std::string soma::IStreamDataSource::url ( ) const

virtual

Reimplemented from soma::DataSource.

writeBlock()

virtual long soma::IStreamDataSource::writeBlock ( const char *  data, unsigned long  len  )

virtual

always fails

Implements soma::DataSource.

---

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

• soma-io/datasource/streamdatasource.h