utility::io::icstream Class Reference

icstream: Input channel stream wrapper class More...

#include <icstream.hh>

Inheritance diagram for utility::io::icstream:

Collaboration diagram for utility::io::icstream:

List of all members.

Public Member Functions
	icstream (std::istream &i_stream_a)
	Constructor.
virtual	~icstream ()
	Destructor.
	operator bool () const
	bool conversion
	operator std::istream const & () const
	Stream conversion.
	operator std::istream & ()
	Stream conversion.
template<typename T >
icstream &	operator>> (T &t)
	Stream input: Override to preserve type of return value.
std::istream &	operator>> (std_manipulator m)
	Stream manipulator input.
void	seek_beg ()
	Seek to the beginning.
int	get ()
	Get the next character.
icstream &	get (char &c)
	Get the next character.
icstream &	get (char *str, std::streamsize const count)
	Get the next specified number of characters.
icstream &	get (char *str, std::streamsize const count, char const delim)
	Get the next specified number of characters.
icstream &	get (std::string &str, std::streamsize const count)
	Get the next specified number of characters.
icstream &	get (std::string &str, std::streamsize const count, char const delim)
	Get the next specified number of characters.
icstream &	getline (char *line, std::streamsize const count)
	Get the rest of the line.
icstream &	getline (char *line, std::streamsize const count, char const delim)
	Get the rest of the line.
icstream &	getline (std::string &line)
	Get the rest of the line.
icstream &	getline (std::string &line, char const delim)
	Get the rest of the line.
icstream &	read (char *str, std::streamsize const count)
	Read the next specified number of characters.
icstream &	read (std::string &str, std::streamsize const count)
	Read the next specified number of characters.
std::streamsize	readsome (char *str, std::streamsize const count)
	Read the next available specified number of characters.
std::streamsize	readsome (std::string &str, std::streamsize const count)
	Read the next available specified number of characters.
icstream &	ignore ()
	Skip over the next character.
icstream &	ignore (std::streamsize const count)
	Skip over the next specified number of characters.
icstream &	ignore (std::streamsize const count, char const delim)
	Skip over the next specified number of characters.
int	peek ()
	Returns the next character without extracting it.
icstream &	unget ()
	Put the last character read back into the stream.
icstream &	putback (char c)
	Put the last character read back into the stream and check that passed character is correct.
void	clear ()
	Clear the stream.
std::istream const &	operator() () const
	Stream access.
std::istream &	operator() ()
	Stream access.
std::istream const &	stream () const
	Stream access.
std::istream &	stream ()
	Stream access.
std::streambuf *	rdbuf () const
	Pointer to the stream buffer.
bool	good () const
	Good?
bool	eof () const
	End of file?
bool	fail () const
	Fail?
bool	bad () const
	Bad?
bool	compressed () const
	Compressed?
bool	uncompressed () const
	Uncompressed?
bool	gzipped () const
	gzipped?

---

Detailed Description

icstream: Input channel stream wrapper class

---

Constructor & Destructor Documentation

utility::io::icstream::icstream

(

std::istream &

i_stream_a

)

[inline]

Constructor.

virtual utility::io::icstream::~icstream

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

bool utility::io::icstream::bad

(

)

const [inline, virtual]

Bad?

Implements utility::io::irstream.

void utility::io::icstream::clear

(

)

[inline, virtual]

Clear the stream.

Implements utility::io::irstream.

bool utility::io::icstream::compressed

(

)

const [inline, virtual]

Compressed?

Implements utility::io::irstream.

bool utility::io::icstream::eof

(

)

const [inline, virtual]

End of file?

Implements utility::io::irstream.

bool utility::io::icstream::fail

(

)

const [inline, virtual]

Fail?

Implements utility::io::irstream.

icstream& utility::io::icstream::get

(

char &

c

)

[inline, virtual]

Get the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::get	(	char *	str,
		std::streamsize const	count
	)		[inline, virtual]

Get the next specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

icstream& utility::io::icstream::get	(	char *	str,
		std::streamsize const	count,
		char const	delim
	)		[inline, virtual]

Get the next specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

icstream& utility::io::icstream::get	(	std::string &	str,
		std::streamsize const	count
	)		[inline, virtual]

Get the next specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

int utility::io::icstream::get

(

)

[inline, virtual]

Get the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::get	(	std::string &	str,
		std::streamsize const	count,
		char const	delim
	)		[inline, virtual]

Get the next specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

icstream& utility::io::icstream::getline	(	std::string &	line,
		char const	delim
	)		[inline, virtual]

Get the rest of the line.

Implements utility::io::irstream.

References getline(), and stream().

icstream& utility::io::icstream::getline	(	char *	line,
		std::streamsize const	count
	)		[inline, virtual]

Get the rest of the line.

Implements utility::io::irstream.

References stream().

Referenced by getline().

icstream& utility::io::icstream::getline	(	char *	line,
		std::streamsize const	count,
		char const	delim
	)		[inline, virtual]

Get the rest of the line.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::getline

(

std::string &

line

)

[inline, virtual]

Get the rest of the line.

Implements utility::io::irstream.

References getline(), and stream().

bool utility::io::icstream::good

(

)

const [inline, virtual]

Good?

Implements utility::io::irstream.

bool utility::io::icstream::gzipped

(

)

const [inline, virtual]

gzipped?

Implements utility::io::irstream.

icstream& utility::io::icstream::ignore

(

)

[inline, virtual]

Skip over the next character.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::ignore

(

std::streamsize const

count

)

[inline, virtual]

Skip over the next specified number of characters.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::ignore	(	std::streamsize const	count,
		char const	delim
	)		[inline, virtual]

Skip over the next specified number of characters.

Implements utility::io::irstream.

References stream().

utility::io::icstream::operator bool

(

)

const [inline, virtual]

bool conversion

Implements utility::io::irstream.

utility::io::icstream::operator std::istream &

(

)

[inline, virtual]

Stream conversion.

Implements utility::io::irstream.

utility::io::icstream::operator std::istream const &

(

)

const [inline, virtual]

Stream conversion.

Implements utility::io::irstream.

std::istream& utility::io::icstream::operator()

(

)

[inline, virtual]

Stream access.

Implements utility::io::irstream.

std::istream const& utility::io::icstream::operator()

(

)

const [inline, virtual]

Stream access.

Implements utility::io::irstream.

template<typename T >

icstream& utility::io::icstream::operator>>

(

T &

t

)

[inline]

Stream input: Override to preserve type of return value.

Reimplemented from utility::io::irstream.

References sd::t.

std::istream& utility::io::icstream::operator>>

(

std_manipulator

m

)

[inline, virtual]

Stream manipulator input.

Implements utility::io::irstream.

int utility::io::icstream::peek

(

)

[inline, virtual]

Returns the next character without extracting it.

Implements utility::io::irstream.

References stream().

icstream& utility::io::icstream::putback

(

char

c

)

[inline, virtual]

Put the last character read back into the stream and check that passed character is correct.

Implements utility::io::irstream.

References stream().

std::streambuf* utility::io::icstream::rdbuf

(

)

const [inline, virtual]

Pointer to the stream buffer.

Implements utility::io::irstream.

icstream& utility::io::icstream::read	(	std::string &	str,
		std::streamsize const	count
	)		[inline, virtual]

Read the next specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

icstream& utility::io::icstream::read	(	char *	str,
		std::streamsize const	count
	)		[inline, virtual]

Read the next specified number of characters.

Implements utility::io::irstream.

References stream().

std::streamsize utility::io::icstream::readsome	(	char *	str,
		std::streamsize const	count
	)		[inline, virtual]

Read the next available specified number of characters.

Implements utility::io::irstream.

References stream().

std::streamsize utility::io::icstream::readsome	(	std::string &	str,
		std::streamsize const	count
	)		[inline, virtual]

Read the next available specified number of characters.

Implements utility::io::irstream.

References get_pdb::count, and stream().

void utility::io::icstream::seek_beg

(

)

[inline, virtual]

Seek to the beginning.

Implements utility::io::irstream.

References stream().

std::istream& utility::io::icstream::stream

(

)

[inline, virtual]

Stream access.

Implements utility::io::irstream.

std::istream const& utility::io::icstream::stream

(

)

const [inline, virtual]

Stream access.

Implements utility::io::irstream.

Referenced by get(), getline(), ignore(), peek(), putback(), read(), readsome(), seek_beg(), and unget().

bool utility::io::icstream::uncompressed

(

)

const [inline, virtual]

Uncompressed?

Implements utility::io::irstream.

icstream& utility::io::icstream::unget

(

)

[inline, virtual]

Put the last character read back into the stream.

Implements utility::io::irstream.

References stream().

---

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

• src/utility/io/icstream.hh