od_istream Class Reference

OD class for stream read. More...

Inheritance diagram for od_istream:

Public Member Functions
	od_istream ()
	od_istream (const char *fnm)
	od_istream (const FilePath &fp)
	od_istream (std::istream *s)
	od_istream (std::istream &s)
	od_istream (const od_istream &s)
od_istream &	operator= (const od_istream &s)
bool	open (const char *)
bool	reOpen ()
od_istream &	get (char &)
od_istream &	get (unsigned char &)
od_istream &	get (short &)
od_istream &	get (unsigned short &)
od_istream &	get (int &)
od_istream &	get (unsigned int &)
od_istream &	get (int64_t &)
od_istream &	get (uint64_t &)
od_istream &	get (long &)
od_istream &	get (unsigned long &)
od_istream &	get (float &)
od_istream &	get (double &)
od_istream &	get (BufferString &bs, bool allowgotonextline=true)
od_istream &	get (IOPar &)
od_istream &	get (SeparString &)
od_istream &	get (CompoundKey &)
od_istream &	getC (char *, int maxnrchar)
od_istream &	get (char *)
	unsafe - use getC instead -> pErrMsg More...
od_istream &	get (FixedString &)
	does nothing + pErrMsg More...
od_istream &	get (void *)
	does nothing + pErrMsg More...
bool	getWord (BufferString &, bool allowgotonextline=true)
bool	getLine (BufferString &, bool *newline_found=0)
bool	getAll (BufferString &)
bool	getBin (void *, Count nrbytes)
template<class T >
od_istream &	getBin (T &)
char	peek () const
void	ignore (Count)
bool	skipUntil (char)
bool	skipWord ()
bool	skipLine ()
void	setReadPosition (Pos p, Ref r=Abs)
Count	lastNrBytesRead () const
std::istream &	stdStream ()
bool	atEOF () const
Public Member Functions inherited from od_stream
virtual	~od_stream ()
bool	isOK () const
	eof is not OK More...
bool	isBad () const
	eof is not Bad More...
uiString	errMsg () const
	see also below. More...
bool	forRead () const
bool	forWrite () const
Pos	position () const
void	setPosition (Pos, Ref r=Abs)
Pos	endPosition () const
const char *	fileName () const
void	setFileName (const char *)
StreamData &	streamData ()
const StreamData &	streamData () const
void	setNoClose (bool yn=true)
void	releaseStream (StreamData &)
void	close ()
void	addErrMsgTo (BufferString &) const
void	addErrMsgTo (uiString &) const

Static Public Member Functions
static od_istream &	nullStream ()
Static Public Member Functions inherited from od_stream
static od_stream *	create (const char *, bool forread, BufferString &errmsg)
	returns null on failure, never a bad stream More...
static od_stream *	create (const char *, bool forread, uiString &errmsg)
	returns null on failure, never a bad stream More...
static const char *	sStdIO ()
	pass this as filename to get cin or cout More...
static const char *	sStdErr ()
	pass this as filename to get cerr More...

Additional Inherited Members
Public Types inherited from od_stream
enum	Ref { Abs, Rel, End }
typedef od_stream_Count	Count
typedef od_stream_Pos	Pos
Protected Member Functions inherited from od_stream
	od_stream ()
	od_stream (const char *, bool, bool editmode=false)
	od_stream (const FilePath &, bool, bool editmode=false)
	od_stream (std::ostream *)
	od_stream (std::ostream &)
	od_stream (std::istream *)
	od_stream (std::istream &)
	od_stream (const od_stream &)
od_stream &	operator= (const od_stream &)
Protected Attributes inherited from od_stream
StreamData &	sd_
bool	mine_
bool	noclose_
uiString	errmsg_

Detailed Description

OD class for stream read.

Constructor & Destructor Documentation

od_istream::od_istream ( )

inline

od_istream::od_istream ( const char *  fnm )

inline

od_istream::od_istream ( const FilePath &  fp )

inline

od_istream::od_istream ( std::istream *  s )

inline

od_istream::od_istream ( std::istream &  s )

inline

od_istream::od_istream ( const od_istream &  s )

inline

Member Function Documentation

bool od_istream::atEOF

(

)

const

equivalent to: !isOK() && !isBad() avoid using it in normal circumstances

od_istream& od_istream::get

(

char &

)

od_istream& od_istream::get

(

unsigned char &

)

od_istream& od_istream::get

(

short &

)

od_istream& od_istream::get

(

unsigned short &

)

od_istream& od_istream::get

(

int &

)

od_istream& od_istream::get

(

unsigned int &

)

od_istream& od_istream::get

(

int64_t &

)

od_istream& od_istream::get

(

uint64_t &

)

od_istream& od_istream::get

(

long &

)

od_istream& od_istream::get

(

unsigned long &

)

od_istream& od_istream::get

(

float &

)

od_istream& od_istream::get

(

double &

)

od_istream& od_istream::get ( BufferString &  bs, bool  allowgotonextline = true  )

inline

od_istream& od_istream::get

(

IOPar &

)

od_istream& od_istream::get

(

SeparString &

)

od_istream& od_istream::get

(

CompoundKey &

)

od_istream& od_istream::get

(

char *

)

unsafe - use getC instead -> pErrMsg

od_istream& od_istream::get

(

FixedString &

)

does nothing + pErrMsg

od_istream& od_istream::get

(

void *

)

does nothing + pErrMsg

bool od_istream::getAll

(

BufferString &

)

bool od_istream::getBin	(	void *	,
		Count	nrbytes
	)

template<class T >

od_istream & od_istream::getBin ( T &  t )

inline

od_istream& od_istream::getC	(	char *	,
		int	maxnrchar
	)

bool od_istream::getLine	(	BufferString &	,
		bool *	newline_found = 0
	)

bool od_istream::getWord	(	BufferString &	,
		bool	allowgotonextline = true
	)

void od_istream::ignore

(

Count

)

Count od_istream::lastNrBytesRead

(

)

const

static od_istream& od_istream::nullStream ( )

static

bool od_istream::open

(

const char *

)

od_istream& od_istream::operator= ( const od_istream &  s )

inline

char od_istream::peek

(

)

const

bool od_istream::reOpen

(

)

void od_istream::setReadPosition ( Pos  p, Ref  r = Abs  )

inline

bool od_istream::skipLine

(

)

bool od_istream::skipUntil

(

char

)

bool od_istream::skipWord

(

)

std::istream& od_istream::stdStream

(

)